lx-ls 0.10.0

//! Extended attribute support for Darwin and Linux systems.

#![allow(trivial_casts)] // for ARM

use std::io;
use std::path::Path;

pub const ENABLED: bool = cfg!(any(target_os = "macos", target_os = "linux"));

pub trait FileAttributes {
    fn attributes(&self) -> io::Result<Vec<Attribute>>;

    /// Cheaply check whether the file has any extended attributes,
    /// without enumerating them.  Uses a single `listxattr` syscall
    /// with a zero-length buffer.
    fn has_attributes(&self) -> io::Result<bool>;
}

#[cfg(any(target_os = "macos", target_os = "linux"))]
impl FileAttributes for Path {
    fn attributes(&self) -> io::Result<Vec<Attribute>> {
        list_attrs(&lister::Lister::new(FollowSymlinks::Yes), self)
    }

    fn has_attributes(&self) -> io::Result<bool> {
        has_attrs(&lister::Lister::new(FollowSymlinks::Yes), self)
    }
}

#[cfg(not(any(target_os = "macos", target_os = "linux")))]
impl FileAttributes for Path {
    fn attributes(&self) -> io::Result<Vec<Attribute>> {
        Ok(Vec::new())
    }

    fn has_attributes(&self) -> io::Result<bool> {
        Ok(false)
    }
}

/// Whether the platform lister should chase symlinks when reading
/// extended attributes.  Both variants are matched by the macOS and
/// Linux `Lister` impls (the Linux path picks between
/// `listxattr`/`llistxattr` etc.), but only `Yes` is constructed
/// today — `lx` always follows symlinks for xattr lookups.  The
/// `No` variant is latent infrastructure for honouring an explicit
/// don't-follow request (e.g. wiring this up to `--symlinks=hide`).
/// Drop the variant — and the `allow` — once that decision lands.
#[cfg(any(target_os = "macos", target_os = "linux"))]
#[derive(Copy, Clone)]
#[allow(dead_code)] // `No` variant is constructed nowhere yet; see doc comment
pub enum FollowSymlinks {
    Yes,
    No,
}

/// Extended attribute
#[derive(Debug, Clone)]
pub struct Attribute {
    pub name: String,
    pub size: usize,
}

#[cfg(any(target_os = "macos", target_os = "linux"))]
pub fn has_attrs(lister: &lister::Lister, path: &Path) -> io::Result<bool> {
    use std::cmp::Ordering;
    use std::ffi::CString;

    let Some(c_path) = path.to_str().and_then(|s| CString::new(s).ok()) else {
        return Err(io::Error::other("Error: path somehow contained a NUL?"));
    };

    let bufsize = lister.listxattr_first(&c_path);
    match bufsize.cmp(&0) {
        Ordering::Less => Err(io::Error::last_os_error()),
        Ordering::Equal => Ok(false),
        Ordering::Greater => Ok(true),
    }
}

#[cfg(any(target_os = "macos", target_os = "linux"))]
pub fn list_attrs(lister: &lister::Lister, path: &Path) -> io::Result<Vec<Attribute>> {
    use std::cmp::Ordering;
    use std::ffi::CString;

    let Some(c_path) = path.to_str().and_then(|s| CString::new(s).ok()) else {
        return Err(io::Error::other("Error: path somehow contained a NUL?"));
    };

    let bufsize = lister.listxattr_first(&c_path);
    match bufsize.cmp(&0) {
        Ordering::Less => return Err(io::Error::last_os_error()),
        Ordering::Equal => return Ok(Vec::new()),
        Ordering::Greater => {}
    }

    let mut buf = vec![0_u8; bufsize as usize];
    let err = lister.listxattr_second(&c_path, &mut buf, bufsize);

    match err.cmp(&0) {
        Ordering::Less => return Err(io::Error::last_os_error()),
        Ordering::Equal => return Ok(Vec::new()),
        Ordering::Greater => {}
    }

    let mut names = Vec::new();
    if err > 0 {
        // End indices of the attribute names
        // the buffer contains 0-terminated c-strings
        let idx = buf
            .iter()
            .enumerate()
            .filter_map(|(i, v)| if *v == 0 { Some(i) } else { None });
        let mut start = 0;

        for end in idx {
            let c_end = end + 1; // end of the c-string (including 0)
            let size = lister.getxattr(&c_path, &buf[start..c_end]);

            if size > 0 {
                names.push(Attribute {
                    name: lister.translate_attribute_name(&buf[start..end]),
                    size: size as usize,
                });
            }

            start = c_end;
        }
    }

    Ok(names)
}

#[cfg(target_os = "macos")]
mod lister {
    use super::FollowSymlinks;
    use libc::{c_char, c_int, c_void, size_t, ssize_t};
    use std::ffi::CString;
    use std::ptr;

    unsafe extern "C" {
        fn listxattr(
            path: *const c_char,
            namebuf: *mut c_char,
            size: size_t,
            options: c_int,
        ) -> ssize_t;

        fn getxattr(
            path: *const c_char,
            name: *const c_char,
            value: *mut c_void,
            size: size_t,
            position: u32,
            options: c_int,
        ) -> ssize_t;
    }

    pub struct Lister {
        c_flags: c_int,
    }

    impl Lister {
        pub fn new(do_follow: FollowSymlinks) -> Self {
            let c_flags: c_int = match do_follow {
                FollowSymlinks::Yes => 0x0001,
                FollowSymlinks::No => 0x0000,
            };

            Self { c_flags }
        }

        pub fn translate_attribute_name(&self, input: &[u8]) -> String {
            unsafe { std::str::from_utf8_unchecked(input).into() }
        }

        pub fn listxattr_first(&self, c_path: &CString) -> ssize_t {
            unsafe { listxattr(c_path.as_ptr(), ptr::null_mut(), 0, self.c_flags) }
        }

        pub fn listxattr_second(
            &self,
            c_path: &CString,
            buf: &mut Vec<u8>,
            bufsize: ssize_t,
        ) -> ssize_t {
            unsafe {
                listxattr(
                    c_path.as_ptr(),
                    buf.as_mut_ptr().cast::<c_char>(),
                    bufsize as size_t,
                    self.c_flags,
                )
            }
        }

        pub fn getxattr(&self, c_path: &CString, buf: &[u8]) -> ssize_t {
            unsafe {
                getxattr(
                    c_path.as_ptr(),
                    buf.as_ptr().cast::<c_char>(),
                    ptr::null_mut(),
                    0,
                    0,
                    self.c_flags,
                )
            }
        }
    }
}

#[cfg(target_os = "linux")]
mod lister {
    use super::FollowSymlinks;
    use libc::{c_char, c_void, size_t, ssize_t};
    use std::ffi::CString;
    use std::ptr;

    unsafe extern "C" {
        fn listxattr(path: *const c_char, list: *mut c_char, size: size_t) -> ssize_t;

        fn llistxattr(path: *const c_char, list: *mut c_char, size: size_t) -> ssize_t;

        fn getxattr(
            path: *const c_char,
            name: *const c_char,
            value: *mut c_void,
            size: size_t,
        ) -> ssize_t;

        fn lgetxattr(
            path: *const c_char,
            name: *const c_char,
            value: *mut c_void,
            size: size_t,
        ) -> ssize_t;
    }

    pub struct Lister {
        follow_symlinks: FollowSymlinks,
    }

    impl Lister {
        pub fn new(follow_symlinks: FollowSymlinks) -> Lister {
            Lister { follow_symlinks }
        }

        pub fn translate_attribute_name(&self, input: &[u8]) -> String {
            String::from_utf8_lossy(input).into_owned()
        }

        pub fn listxattr_first(&self, c_path: &CString) -> ssize_t {
            let listxattr = match self.follow_symlinks {
                FollowSymlinks::Yes => listxattr,
                FollowSymlinks::No => llistxattr,
            };

            unsafe { listxattr(c_path.as_ptr().cast(), ptr::null_mut(), 0) }
        }

        pub fn listxattr_second(
            &self,
            c_path: &CString,
            buf: &mut Vec<u8>,
            bufsize: ssize_t,
        ) -> ssize_t {
            let listxattr = match self.follow_symlinks {
                FollowSymlinks::Yes => listxattr,
                FollowSymlinks::No => llistxattr,
            };

            unsafe {
                listxattr(
                    c_path.as_ptr().cast(),
                    buf.as_mut_ptr().cast(),
                    bufsize as size_t,
                )
            }
        }

        pub fn getxattr(&self, c_path: &CString, buf: &[u8]) -> ssize_t {
            let getxattr = match self.follow_symlinks {
                FollowSymlinks::Yes => getxattr,
                FollowSymlinks::No => lgetxattr,
            };

            unsafe {
                getxattr(
                    c_path.as_ptr().cast(),
                    buf.as_ptr().cast(),
                    ptr::null_mut(),
                    0,
                )
            }
        }
    }
}