eza/unix.rs

use std::str::raw::from_c_str;
use std::ptr::read;
use std::collections::hashmap::HashMap;

mod c {
    #![allow(non_camel_case_types)]
    extern crate libc;
    pub use self::libc::{
        c_char,
        c_int,
        uid_t,
        gid_t,
        time_t
    };

    pub struct c_passwd {
        pub pw_name:    *c_char,  // login name
        pub pw_passwd:  *c_char,
        pub pw_uid:     c_int,    // user ID
        pub pw_gid:     c_int,    // group ID
        pub pw_change:  time_t,
        pub pw_class:   *c_char,
        pub pw_gecos:   *c_char,  // full name
        pub pw_dir:     *c_char,  // login dir
        pub pw_shell:   *c_char,  // login shell
        pub pw_expire:  time_t    // password expiry time
    }

    pub struct c_group {
        pub gr_name:   *c_char,   // group name
        pub gr_passwd: *c_char,   // password
        pub gr_gid:    gid_t,     // group id
        pub gr_mem:    **c_char,  // names of users in the group
    }

    extern {
        pub fn getpwuid(uid: c_int) -> *c_passwd;
        pub fn getgrgid(gid: uid_t) -> *c_group;
        pub fn getuid() -> libc::c_int;
    }
}
pub struct Unix {
    user_names:    HashMap<u32, Option<String>>,  // mapping of user IDs to user names
    group_names:   HashMap<u32, Option<String>>,  // mapping of groups IDs to group names
    groups:        HashMap<u32, bool>,            // mapping of group IDs to whether the current user is a member
    pub uid:       u32,                           // current user's ID
    pub username:  String,                        // current user's name
}

impl Unix {
    pub fn empty_cache() -> Unix {
        let uid = unsafe { c::getuid() };
        let info = unsafe { c::getpwuid(uid as i32).to_option().unwrap() };  // the user has to have a name

        let username = unsafe { from_c_str(info.pw_name) };

        let mut user_names = HashMap::new();
        user_names.insert(uid as u32, Some(username.clone()));

        // Unix groups work like this: every group has a list of
        // users, referred to by their names. But, every user also has
        // a primary group, which isn't in this list. So handle this
        // case immediately after we look up the user's details.
        let mut groups = HashMap::new();
        groups.insert(info.pw_gid as u32, true);

        Unix {
            user_names:  user_names,
            group_names: HashMap::new(),
            uid:         uid as u32,
            username:    username,
            groups:      groups,
        }
    }

    pub fn is_group_member(&mut self, gid: u32) -> bool {
        // Groups that no longer exist have no members. If this method
        // is called before a group with the given gid has been read,
        // it doesn't exist, so insert false.
        *self.groups.find_or_insert(gid, false)
    }

    pub fn get_user_name(&mut self, uid: u32) -> Option<String> {
        self.user_names.find_or_insert_with(uid, |&u| {
            let pw = unsafe { c::getpwuid(u as i32) };
            if pw.is_not_null() {
                return unsafe { Some(from_c_str(read(pw).pw_name)) };
            }
            else {
                return None;
            }
        }).clone()
    }

    fn group_membership(group: **i8, uname: &String) -> bool {
        let mut i = 0;

        // The list of members is a pointer to a pointer of
        // characters, terminated by a null pointer. So the first call
        // to `to_option` will always succeed, as that memory is
        // guaranteed to be there (unless we go past the end of RAM).
        // The second call will return None if it's a null pointer.

        loop {
            match unsafe { group.offset(i).to_option().unwrap().to_option() } {
                Some(username) => {
                    if unsafe { from_c_str(username) } == *uname {
                        return true;
                    }
                }
                None => {
                    return false;
                }
            }
            i += 1;
        }
    }

    pub fn get_group_name(&mut self, gid: u32) -> Option<String> {
        match self.group_names.find_copy(&gid) {
            Some(name) => name,
            None => {
                match unsafe { c::getgrgid(gid).to_option() } {
                    None => {
                        self.group_names.insert(gid, None);
                        return None;
                    },
                    Some(r) => {
                        let group_name = unsafe { Some(from_c_str(r.gr_name)) };
                        self.group_names.insert(gid, group_name.clone());

                        // Calculate whether we are a member of the
                        // group. Now's as good a time as any as we've
                        // just retrieved the group details.
                        
                        if !self.groups.contains_key(&gid) {
                            self.groups.insert(gid, Unix::group_membership(r.gr_mem, &self.username));
                        }
                        
                        return group_name;
                    }
                }
            }
        }
    }
}