home-0.5.1/.gitignore010064400017500001750000000000231352720333400126530ustar0000000000000000target/ Cargo.lock home-0.5.1/.travis.yml010064400017500001750000000010631352544643300130100ustar0000000000000000dist: xenial language: rust rust: - stable git: depth: 1 quiet: true matrix: fast_finish: true include: - os: linux env: TARGET=x86_64-unknown-linux-gnu - os: osx osx_image: xcode9.2 env: MACOSX_DEPLOYMENT_TARGET=10.7 TARGET=x86_64-apple-darwin - os: windows env: TARGET=x86_64-pc-windows-msvc EXE_EXT=.exe services: nil - name: rustfmt install: - rustup component add rustfmt script: - cargo fmt --all -- --check script: - cargo build --verbose - cargo test --verbose home-0.5.1/CHANGELOG.md010064400017500001750000000016311355014712400125020ustar0000000000000000# Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [0.5.1] - 2019-10-12 ### Changed - Disable unnecessary features for `scopeguard`. Thanks @mati865. ## [0.5.0] - 2019-08-21 ### Added - Add `home_dir` implementation for Windows UWP platforms. ### Fixed - Fix `rustup_home` implementation when `RUSTUP_HOME` is an absolute directory. - Fix `cargo_home` implementation when `CARGO_HOME` is an absolute directory. ### Removed - Remove support for `multirust` folder used in old version of `rustup`. [Unreleased]: https://github.com/brson/home/compare/v0.5.0...HEAD [0.5.1]: https://github.com/brson/home/compare/v0.5.0...v0.5.1 [0.5.0]: https://github.com/brson/home/compare/0.4.2...v0.5.0 home-0.5.1/Cargo.toml.orig010064400017500001750000000011411355014712400135540ustar0000000000000000[package] name = "home" version = "0.5.1" # also update `html_root_url` in `src/lib.rs` authors = [ "Brian Anderson " ] documentation = "https://docs.rs/home" edition = "2018" license = "MIT OR Apache-2.0" repository = "https://github.com/brson/home" description = "Shared definitions of home directories" [target."cfg(windows)".dependencies.scopeguard] version = "1" default-features = false [target."cfg(windows)".dependencies.winapi] version = "0.3" features = [ "errhandlingapi", "handleapi", "processthreadsapi", "std", "winerror", "winnt", "userenv", ] home-0.5.1/Cargo.toml0000644000000020360000000000000100250ustar00# 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 believe there's an error in this file please file an # issue against the rust-lang/cargo repository. If you're # editing this file be aware that the upstream Cargo.toml # will likely look very different (and much more reasonable) [package] edition = "2018" name = "home" version = "0.5.1" authors = ["Brian Anderson "] description = "Shared definitions of home directories" documentation = "https://docs.rs/home" license = "MIT OR Apache-2.0" repository = "https://github.com/brson/home" [target."cfg(windows)".dependencies.scopeguard] version = "1" default-features = false [target."cfg(windows)".dependencies.winapi] version = "0.3" features = ["errhandlingapi", "handleapi", "processthreadsapi", "std", "winerror", "winnt", "userenv"] home-0.5.1/LICENSE-APACHE010064400017500001750000000261201353167210300126140ustar0000000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2019 Brian Anderson Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. home-0.5.1/LICENSE-MIT010064400017500001750000000020571353167210300123270ustar0000000000000000MIT License Copyright (c) 2019 Brian Anderson 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. home-0.5.1/README.md010060000017500001750000000016311347445157500121550ustar0000000000000000Canonical definitions of `home_dir`, `cargo_home`, and `rustup_home`. This provides the definition of `home_dir` used by Cargo and rustup, as well functions to find the correct value of `CARGO_HOME` and `RUSTUP_HOME`. The definition of `home_dir` provided by the standard library is incorrect because it considers the `HOME` environment variable on Windows. This causes surprising situations where a Rust program will behave differently depending on whether it is run under a Unix emulation environment like Cygwin or MinGW. Neither Cargo nor rustup use the standard libraries definition - they use the definition here. This crate further provides two functions, `cargo_home` and `rustup_home`, which are the canonical way to determine the location that Cargo and rustup store their data. See [rust-lang/rust#43321]. [rust-lang/rust#43321]: https://github.com/rust-lang/rust/issues/43321 ## License MIT/Apache-2.0 home-0.5.1/src/lib.rs010064400017500001750000000133361355014712400126010ustar0000000000000000//! Canonical definitions of `home_dir`, `cargo_home`, and `rustup_home`. //! //! This provides the definition of `home_dir` used by Cargo and //! rustup, as well functions to find the correct value of //! `CARGO_HOME` and `RUSTUP_HOME`. //! //! See also the [`dirs`](https://docs.rs/dirs) crate. //! //! _Note that as of 2019/08/06 it appears that cargo uses this crate. And //! rustup has used this crate since 2019/08/21._ //! //! The definition of `home_dir` provided by the standard library is //! incorrect because it considers the `HOME` environment variable on //! Windows. This causes surprising situations where a Rust program //! will behave differently depending on whether it is run under a //! Unix emulation environment like Cygwin or MinGW. Neither Cargo nor //! rustup use the standard libraries definition - they use the //! definition here. //! //! This crate further provides two functions, `cargo_home` and //! `rustup_home`, which are the canonical way to determine the //! location that Cargo and rustup store their data. //! //! See [rust-lang/rust#43321]. //! //! [rust-lang/rust#43321]: https://github.com/rust-lang/rust/issues/43321 #![doc(html_root_url = "https://docs.rs/home/0.5.1")] #![deny(rust_2018_idioms)] mod windows; use std::env; use std::io; use std::path::{Path, PathBuf}; /// Returns the path of the current user's home directory if known. /// /// # Unix /// /// Returns the value of the `HOME` environment variable if it is set /// and not equal to the empty string. Otherwise, it tries to determine the /// home directory by invoking the `getpwuid_r` function on the UID of the /// current user. /// /// # Windows /// /// Returns the value of the `USERPROFILE` environment variable if it /// is set and not equal to the empty string. If both do not exist, /// [`GetUserProfileDirectory`][msdn] is used to return the /// appropriate path. /// /// [msdn]: https://msdn.microsoft.com/en-us/library/windows/desktop/bb762280(v=vs.85).aspx /// /// # Examples /// /// ``` /// match home::home_dir() { /// Some(path) => println!("{}", path.display()), /// None => println!("Impossible to get your home dir!"), /// } /// ``` pub fn home_dir() -> Option { home_dir_inner() } #[cfg(windows)] use windows::home_dir_inner; #[cfg(any(unix, target_os = "redox"))] fn home_dir_inner() -> Option { #[allow(deprecated)] env::home_dir() } /// Returns the storage directory used by Cargo, often knowns as /// `.cargo` or `CARGO_HOME`. /// /// It returns one of the following values, in this order of /// preference: /// /// - The value of the `CARGO_HOME` environment variable, if it is /// an absolute path. /// - The value of the current working directory joined with the value /// of the `CARGO_HOME` environment variable, if `CARGO_HOME` is a /// relative directory. /// - The `.cargo` directory in the user's home directory, as reported /// by the `home_dir` function. /// /// # Errors /// /// This function fails if it fails to retrieve the current directory, /// or if the home directory cannot be determined. /// /// # Examples /// /// ``` /// match home::cargo_home() { /// Ok(path) => println!("{}", path.display()), /// Err(err) => eprintln!("Cannot get your cargo home dir: {:?}", err), /// } /// ``` pub fn cargo_home() -> io::Result { let cwd = env::current_dir()?; cargo_home_with_cwd(&cwd) } pub fn cargo_home_with_cwd(cwd: &Path) -> io::Result { let cargo_home_env = match env::var_os("CARGO_HOME") { Some(p) => match p.as_os_str().to_str() { Some(q) if !q.trim().is_empty() => Some(p), _ => None, }, _ => None, }; match cargo_home_env { Some(home) => { let home = PathBuf::from(home); if home.is_absolute() { Ok(home) } else { Ok(cwd.join(&home)) } } None => home_dir() .map(|p| p.join(".cargo")) .ok_or_else(|| io::Error::new(io::ErrorKind::Other, "could not find cargo home dir")), } } /// Returns the storage directory used by rustup, often knowns as /// `.rustup` or `RUSTUP_HOME`. /// /// It returns one of the following values, in this order of /// preference: /// /// - The value of the `RUSTUP_HOME` environment variable, if it is /// an absolute path. /// - The value of the current working directory joined with the value /// of the `RUSTUP_HOME` environment variable, if `RUSTUP_HOME` is a /// relative directory. /// - The `.rustup` directory in the user's home directory, as reported /// by the `home_dir` function. /// /// As a matter of backwards compatibility, this function _may_ return /// the `.multirust` directory in the user's home directory, only if /// it determines that the user is running an old version of rustup /// where that is necessary. /// /// # Errors /// /// This function fails if it fails to retrieve the current directory, /// or if the home directory cannot be determined. /// /// # Examples /// /// ``` /// match home::rustup_home() { /// Ok(path) => println!("{}", path.display()), /// Err(err) => eprintln!("Cannot get your rustup home dir: {:?}", err), /// } /// ``` pub fn rustup_home() -> io::Result { let cwd = env::current_dir()?; rustup_home_with_cwd(&cwd) } pub fn rustup_home_with_cwd(cwd: &Path) -> io::Result { match env::var_os("RUSTUP_HOME") { Some(home) => { let home = PathBuf::from(home); if home.is_absolute() { Ok(home) } else { Ok(cwd.join(&home)) } } None => home_dir() .map(|d| d.join(".rustup")) .ok_or_else(|| io::Error::new(io::ErrorKind::Other, "could not find rustup home dir")), } } home-0.5.1/src/windows.rs010064400017500001750000000101441355014712400135170ustar0000000000000000#![cfg(windows)] use std::env; use std::ffi::OsString; use std::io; use std::os::windows::ffi::OsStringExt; use std::path::PathBuf; use std::ptr; use winapi::shared::minwindef::DWORD; use winapi::shared::winerror::ERROR_INSUFFICIENT_BUFFER; use winapi::um::errhandlingapi::{GetLastError, SetLastError}; use winapi::um::handleapi::CloseHandle; use winapi::um::processthreadsapi::{GetCurrentProcess, OpenProcessToken}; use winapi::um::userenv::GetUserProfileDirectoryW; use winapi::um::winnt::TOKEN_READ; pub fn home_dir_inner() -> Option { env::var_os("USERPROFILE") .map(PathBuf::from) .or_else(home_dir_crt) } #[cfg(not(target_vendor = "uwp"))] fn home_dir_crt() -> Option { unsafe { let me = GetCurrentProcess(); let mut token = ptr::null_mut(); if OpenProcessToken(me, TOKEN_READ, &mut token) == 0 { return None; } let _g = scopeguard::guard(token, |h| { let _ = CloseHandle(h); }); fill_utf16_buf( |buf, mut sz| { match GetUserProfileDirectoryW(token, buf, &mut sz) { 0 if GetLastError() != ERROR_INSUFFICIENT_BUFFER => 0, 0 => sz, _ => sz - 1, // sz includes the null terminator } }, os2path, ) .ok() } } #[cfg(target_vendor = "uwp")] fn home_dir_crt() -> Option { None } fn os2path(s: &[u16]) -> PathBuf { PathBuf::from(OsString::from_wide(s)) } // Many Windows APIs follow a pattern of where we hand a buffer and then they // will report back to us how large the buffer should be or how many bytes // currently reside in the buffer. This function is an abstraction over these // functions by making them easier to call. // // The first callback, `f1`, is yielded a (pointer, len) pair which can be // passed to a syscall. The `ptr` is valid for `len` items (u16 in this case). // The closure is expected to return what the syscall returns which will be // interpreted by this function to determine if the syscall needs to be invoked // again (with more buffer space). // // Once the syscall has completed (errors bail out early) the second closure is // yielded the data which has been read from the syscall. The return value // from this closure is then the return value of the function. // // Taken from rust-lang/rust/src/libstd/sys/windows/mod.rs#L106 fn fill_utf16_buf(mut f1: F1, f2: F2) -> io::Result where F1: FnMut(*mut u16, DWORD) -> DWORD, F2: FnOnce(&[u16]) -> T, { // Start off with a stack buf but then spill over to the heap if we end up // needing more space. let mut stack_buf = [0u16; 512]; let mut heap_buf = Vec::new(); unsafe { let mut n = stack_buf.len(); loop { let buf = if n <= stack_buf.len() { &mut stack_buf[..] } else { let extra = n - heap_buf.len(); heap_buf.reserve(extra); heap_buf.set_len(n); &mut heap_buf[..] }; // This function is typically called on windows API functions which // will return the correct length of the string, but these functions // also return the `0` on error. In some cases, however, the // returned "correct length" may actually be 0! // // To handle this case we call `SetLastError` to reset it to 0 and // then check it again if we get the "0 error value". If the "last // error" is still 0 then we interpret it as a 0 length buffer and // not an actual error. SetLastError(0); let k = match f1(buf.as_mut_ptr(), n as DWORD) { 0 if GetLastError() == 0 => 0, 0 => return Err(io::Error::last_os_error()), n => n, } as usize; if k == n && GetLastError() == ERROR_INSUFFICIENT_BUFFER { n *= 2; } else if k >= n { n = k; } else { return Ok(f2(&buf[..k])); } } } } home-0.5.1/.cargo_vcs_info.json0000644000000001120000000000000120200ustar00{ "git": { "sha1": "ef18523ab49d167e6a085741fb99caf5506190e9" } }