    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
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242

    use std::path::{Path, PathBuf};
    use std::time::Duration;

    pub use self::canonical_url::CanonicalUrl;
    pub use self::context::{homedir, ConfigValue, GlobalContext};
    pub(crate) use self::counter::MetricsCounter;
    pub use self::dependency_queue::DependencyQueue;
    pub use self::diagnostic_server::RustfixDiagnosticServer;
    pub use self::edit_distance::{closest, closest_msg, edit_distance};
    pub use self::errors::CliError;
    pub use self::errors::{internal, CargoResult, CliResult};
    pub use self::flock::{FileLock, Filesystem};
    pub use self::graph::Graph;
    pub use self::hasher::StableHasher;
    pub use self::hex::{hash_u64, short_hash, to_hex};
    pub use self::hostname::hostname;
    pub use self::into_url::IntoUrl;
    pub use self::into_url_with_base::IntoUrlWithBase;
    pub(crate) use self::io::LimitErrorReader;
    pub use self::lockserver::{LockServer, LockServerClient, LockServerStarted};
    pub use self::progress::{Progress, ProgressStyle};
    pub use self::queue::Queue;
    pub use self::rustc::Rustc;
    pub use self::semver_ext::{OptVersionReq, VersionExt};
    pub use self::vcs::{existing_vcs_repo, FossilRepo, GitRepo, HgRepo, PijulRepo};
    pub use self::workspace::{
        add_path_args, path_args, print_available_benches, print_available_binaries,
        print_available_examples, print_available_packages, print_available_tests,
    };

    pub mod auth;
    pub mod cache_lock;
    mod canonical_url;
    pub mod command_prelude;
    pub mod context;
    mod counter;
    pub mod cpu;
    pub mod credential;
    mod dependency_queue;
    pub mod diagnostic_server;
    pub mod edit_distance;
    pub mod errors;
    mod flock;
    pub mod graph;
    mod hasher;
    pub mod hex;
    mod hostname;
    pub mod important_paths;
    pub mod interning;
    pub mod into_url;
    mod into_url_with_base;
    mod io;
    pub mod job;
    mod lockserver;
    pub mod machine_message;
    pub mod network;
    mod progress;
    mod queue;
    pub mod restricted_names;
    pub mod rustc;
    mod semver_ext;
    pub mod sqlite;
    pub mod style;
    pub mod toml;
    pub mod toml_mut;
    mod vcs;
    mod workspace;

    pub fn is_rustup() -> bool {
        // ALLOWED: `RUSTUP_HOME` should only be read from process env, otherwise
        // other tools may point to executables from incompatible distributions.
        #[allow(clippy::disallowed_methods)]
        std::env::var_os("RUSTUP_HOME").is_some()
    }

    pub fn elapsed(duration: Duration) -> String {
        let secs = duration.as_secs();

        if secs >= 60 {
            format!("{}m {:02}s", secs / 60, secs % 60)
        } else {
            format!("{}.{:02}s", secs, duration.subsec_nanos() / 10_000_000)
        }
    }

    /// Formats a number of bytes into a human readable SI-prefixed size.
    /// Returns a tuple of `(quantity, units)`.
    pub fn human_readable_bytes(bytes: u64) -> (f32, &'static str) {
        static UNITS: [&str; 7] = ["B", "KiB", "MiB", "GiB", "TiB", "PiB", "EiB"];
        let bytes = bytes as f32;
        let i = ((bytes.log2() / 10.0) as usize).min(UNITS.len() - 1);
        (bytes / 1024_f32.powi(i as i32), UNITS[i])
    }

    pub fn indented_lines(text: &str) -> String {
        text.lines()
            .map(|line| {
                if line.is_empty() {
                    String::from("\n")
                } else {
                    format!("  {}\n", line)
                }
            })
            .collect()
    }

    pub fn truncate_with_ellipsis(s: &str, max_width: usize) -> String {
        // We should truncate at grapheme-boundary and compute character-widths,
        // yet the dependencies on unicode-segmentation and unicode-width are
        // not worth it.
        let mut chars = s.chars();
        let mut prefix = (&mut chars).take(max_width - 1).collect::<String>();
        if chars.next().is_some() {
            prefix.push('…');
        }
        prefix
    }

    #[cfg(not(windows))]
    #[inline]
    pub fn try_canonicalize<P: AsRef<Path>>(path: P) -> std::io::Result<PathBuf> {
        std::fs::canonicalize(&path)
    }

    #[cfg(windows)]
    #[inline]
    pub fn try_canonicalize<P: AsRef<Path>>(path: P) -> std::io::Result<PathBuf> {
        use std::ffi::OsString;
        use std::io::Error;
        use std::os::windows::ffi::{OsStrExt, OsStringExt};
        use std::{io::ErrorKind, ptr};
        use windows_sys::Win32::Foundation::{GetLastError, SetLastError};
        use windows_sys::Win32::Storage::FileSystem::GetFullPathNameW;

        // On Windows `canonicalize` may fail, so we fall back to getting an absolute path.
        std::fs::canonicalize(&path).or_else(|_| {
            // Return an error if a file does not exist for better compatibility with `canonicalize`
            if !path.as_ref().try_exists()? {
                return Err(Error::new(ErrorKind::NotFound, "the path was not found"));
            }

            // This code is based on the unstable `std::path::absolute` and could be replaced with it
            // if it's stabilized.

            let path = path.as_ref().as_os_str();
            let mut path_u16 = Vec::with_capacity(path.len() + 1);
            path_u16.extend(path.encode_wide());
            if path_u16.iter().find(|c| **c == 0).is_some() {
                return Err(Error::new(
                    ErrorKind::InvalidInput,
                    "strings passed to WinAPI cannot contain NULs",
                ));
            }
            path_u16.push(0);

            loop {
                unsafe {
                    SetLastError(0);
                    let len =
                        GetFullPathNameW(path_u16.as_ptr(), 0, &mut [] as *mut u16, ptr::null_mut());
                    if len == 0 {
                        let error = GetLastError();
                        if error != 0 {
                            return Err(Error::from_raw_os_error(error as i32));
                        }
                    }
                    let mut result = vec![0u16; len as usize];

                    let write_len = GetFullPathNameW(
                        path_u16.as_ptr(),
                        result.len().try_into().unwrap(),
                        result.as_mut_ptr().cast::<u16>(),
                        ptr::null_mut(),
                    );
                    if write_len == 0 {
                        let error = GetLastError();
                        if error != 0 {
                            return Err(Error::from_raw_os_error(error as i32));
                        }
                    }

                    if write_len <= len {
                        return Ok(PathBuf::from(OsString::from_wide(
                            &result[0..(write_len as usize)],
                        )));
                    }
                }
            }
        })
    }

    /// Get the current [`umask`] value.
    ///
    /// [`umask`]: https://man7.org/linux/man-pages/man2/umask.2.html
    #[cfg(unix)]
    pub fn get_umask() -> u32 {
        use std::sync::OnceLock;
        static UMASK: OnceLock<libc::mode_t> = OnceLock::new();
        // SAFETY: Syscalls are unsafe. Calling `umask` twice is even unsafer for
        // multithreading program, since it doesn't provide a way to retrieve the
        // value without modifications. We use a static `OnceLock` here to ensure
        // it only gets call once during the entire program lifetime.
        *UMASK.get_or_init(|| unsafe {
            let umask = libc::umask(0o022);
            libc::umask(umask);
            umask
        }) as u32 // it is u16 on macos
    }

    #[cfg(test)]
    mod test {
        use super::*;

        #[test]
        fn test_human_readable_bytes() {
            assert_eq!(human_readable_bytes(0), (0., "B"));
            assert_eq!(human_readable_bytes(8), (8., "B"));
            assert_eq!(human_readable_bytes(1000), (1000., "B"));
            assert_eq!(human_readable_bytes(1024), (1., "KiB"));
            assert_eq!(human_readable_bytes(1024 * 420 + 512), (420.5, "KiB"));
            assert_eq!(human_readable_bytes(1024 * 1024), (1., "MiB"));
            assert_eq!(
                human_readable_bytes(1024 * 1024 + 1024 * 256),
                (1.25, "MiB")
            );
            assert_eq!(human_readable_bytes(1024 * 1024 * 1024), (1., "GiB"));
            assert_eq!(
                human_readable_bytes((1024. * 1024. * 1024. * 3.1415) as u64),
                (3.1415, "GiB")
            );
            assert_eq!(human_readable_bytes(1024 * 1024 * 1024 * 1024), (1., "TiB"));
            assert_eq!(
                human_readable_bytes(1024 * 1024 * 1024 * 1024 * 1024),
                (1., "PiB")
            );
            assert_eq!(
                human_readable_bytes(1024 * 1024 * 1024 * 1024 * 1024 * 1024),
                (1., "EiB")
            );
            assert_eq!(human_readable_bytes(u64::MAX), (16., "EiB"));
        }
    }