apr 0.4.4

//! URI parsing and manipulation.
use crate::pool::Pool;
use alloc::string::{String, ToString};
pub use apr_sys::apr_uri_t;
use core::ffi::CStr;
use core::marker::PhantomData;

/// A structure to represent a URI.
#[derive(Debug)]
pub struct Uri<'pool> {
    ptr: *mut apr_uri_t,
    _pool: PhantomData<&'pool Pool<'pool>>,
}

impl<'pool> Uri<'pool> {
    /// Return the scheme of the URI.
    pub fn scheme(&self) -> Option<&str> {
        unsafe {
            if (*self.ptr).scheme.is_null() {
                None
            } else {
                Some(CStr::from_ptr((*self.ptr).scheme).to_str().unwrap())
            }
        }
    }

    /// Return the hostinfo of the URI.
    pub fn hostinfo(&self) -> Option<&str> {
        unsafe {
            if (*self.ptr).hostinfo.is_null() {
                None
            } else {
                Some(CStr::from_ptr((*self.ptr).hostinfo).to_str().unwrap())
            }
        }
    }

    /// Return the username of the URI.
    pub fn user(&self) -> Option<&str> {
        unsafe {
            if (*self.ptr).user.is_null() {
                None
            } else {
                Some(CStr::from_ptr((*self.ptr).user).to_str().unwrap())
            }
        }
    }

    /// Return the password of the URI.
    pub fn password(&self) -> Option<&str> {
        unsafe {
            if (*self.ptr).password.is_null() {
                None
            } else {
                Some(CStr::from_ptr((*self.ptr).password).to_str().unwrap())
            }
        }
    }

    /// Return the hostname of the URI.
    pub fn hostname(&self) -> Option<&str> {
        unsafe {
            if (*self.ptr).hostname.is_null() {
                None
            } else {
                Some(CStr::from_ptr((*self.ptr).hostname).to_str().unwrap())
            }
        }
    }

    /// Return the port of the URI.
    pub fn port(&self) -> u16 {
        unsafe { (*self.ptr).port }
    }

    /// Return the path of the URI.
    pub fn path(&self) -> Option<&str> {
        unsafe {
            if (*self.ptr).path.is_null() {
                None
            } else {
                Some(CStr::from_ptr((*self.ptr).path).to_str().unwrap())
            }
        }
    }

    /// Return the query of the URI.
    pub fn query(&self) -> Option<&str> {
        unsafe {
            if (*self.ptr).query.is_null() {
                None
            } else {
                Some(CStr::from_ptr((*self.ptr).query).to_str().unwrap())
            }
        }
    }

    /// Return the fragment of the URI.
    pub fn fragment(&self) -> Option<&str> {
        unsafe {
            if (*self.ptr).fragment.is_null() {
                None
            } else {
                Some(CStr::from_ptr((*self.ptr).fragment).to_str().unwrap())
            }
        }
    }

    /// Return the port as a string
    pub fn port_str(&self) -> Option<&str> {
        unsafe {
            if (*self.ptr).port_str.is_null() {
                None
            } else {
                Some(CStr::from_ptr((*self.ptr).port_str).to_str().unwrap())
            }
        }
    }

    /// Return whether the URI has been initialized.
    pub fn is_initialized(&self) -> bool {
        unsafe { (*self.ptr).is_initialized() != 0 }
    }

    /// Return whether the DNS has been looked up.
    pub fn dns_looked_up(&self) -> bool {
        unsafe { (*self.ptr).dns_looked_up() != 0 }
    }

    /// Return whether the DNS has been resolved.
    pub fn dns_resolved(&self) -> bool {
        unsafe { (*self.ptr).dns_resolved() != 0 }
    }

    /// Unparse the URI, returning a string.
    pub fn unparse(&self, flags: u32) -> String {
        let pool = crate::Pool::new();
        unsafe {
            CStr::from_ptr(apr_sys::apr_uri_unparse(pool.as_mut_ptr(), self.ptr, flags))
                .to_str()
                .unwrap()
        }
        .to_string()
    }

    /// Parse a hostinfo string.
    pub fn parse_hostinfo(pool: &'pool Pool, hostinfo: &str) -> Result<Self, crate::Status> {
        let uri = pool.calloc::<apr_uri_t>();
        let hostinfo = alloc::ffi::CString::new(hostinfo).unwrap();
        let status = unsafe {
            apr_sys::apr_uri_parse_hostinfo(
                pool.as_mut_ptr(),
                hostinfo.as_ptr() as *const core::ffi::c_char,
                uri,
            )
        };
        let status = crate::Status::from(status);
        if status.is_success() {
            Ok(Uri {
                ptr: uri,
                _pool: PhantomData,
            })
        } else {
            Err(status)
        }
    }

    /// Parse a URI string.
    pub fn parse(pool: &'pool Pool, url: &str) -> Result<Self, crate::Status> {
        let uri = pool.calloc::<apr_uri_t>();
        let url = alloc::ffi::CString::new(url).unwrap();
        let status = unsafe {
            apr_sys::apr_uri_parse(
                pool.as_mut_ptr(),
                url.as_ptr() as *const core::ffi::c_char,
                uri,
            )
        };
        let status = crate::Status::from(status);
        if status.is_success() {
            Ok(Uri {
                ptr: uri,
                _pool: PhantomData,
            })
        } else {
            Err(status)
        }
    }

    /// Get a raw pointer to the underlying apr_uri_t
    pub fn as_ptr(&self) -> *const apr_uri_t {
        self.ptr
    }

    /// Get a mutable raw pointer to the underlying apr_uri_t
    ///
    /// # Safety
    ///
    /// The caller must ensure that any modifications made through the returned
    /// pointer are valid and do not violate APR's invariants.
    pub unsafe fn as_mut_ptr(&mut self) -> *mut apr_uri_t {
        self.ptr
    }
}

// Add Display implementation
impl<'pool> core::fmt::Display for Uri<'pool> {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        write!(f, "{}", self.unparse(0))
    }
}

// Add PartialEq implementation
impl<'pool> PartialEq for Uri<'pool> {
    fn eq(&self, other: &Self) -> bool {
        self.unparse(0) == other.unparse(0)
    }
}

// Add AsRef implementations for easy access to string parts
impl<'pool> AsRef<str> for Uri<'pool> {
    fn as_ref(&self) -> &str {
        self.scheme().unwrap_or("")
    }
}

/// Return the default port for a given scheme.
pub fn port_of_scheme(scheme: &str) -> u16 {
    let scheme = alloc::ffi::CString::new(scheme).unwrap();
    unsafe { apr_sys::apr_uri_port_of_scheme(scheme.as_ptr() as *const core::ffi::c_char) }
}

#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn test_port_of_scheme() {
        assert_eq!(80, super::port_of_scheme("http"));
        assert_eq!(443, super::port_of_scheme("https"));
        assert_eq!(0, super::port_of_scheme("unknown"));
    }

    #[test]
    fn test_parse() {
        let pool = Pool::new();
        let uri = super::Uri::parse(&pool, "http://example.com:8080/").unwrap();
        assert_eq!("http", uri.scheme().unwrap());
        assert_eq!(Some("example.com:8080"), uri.hostinfo());
        assert_eq!(Some("example.com"), uri.hostname());
        assert_eq!(8080, uri.port());
        assert_eq!(Some("/"), uri.path());
        assert_eq!(None, uri.query());
        assert_eq!(None, uri.fragment());
        assert_eq!(Some("8080"), uri.port_str());
        // TODO: bitfield accessors are broken on Windows/MSVC
        // https://github.com/rust-lang/rust-bindgen/issues/3184
        #[cfg(not(target_os = "windows"))]
        {
            assert!(uri.is_initialized());
            assert!(!uri.dns_looked_up());
            assert!(!uri.dns_resolved());
        }
    }

    #[test]
    fn test_parse_hostinfo() {
        let pool = Pool::new();
        let uri = super::Uri::parse_hostinfo(&pool, "example.com:8080").unwrap();
        assert_eq!(None, uri.scheme());
        assert_eq!(Some("example.com:8080"), uri.hostinfo());
        assert_eq!(Some("example.com"), uri.hostname());
        assert_eq!(8080, uri.port());
        assert_eq!(None, uri.path());
        assert_eq!(None, uri.query());
        assert_eq!(None, uri.fragment());
        assert_eq!(Some("8080"), uri.port_str());
        // TODO: bitfield accessors are broken on Windows/MSVC
        // https://github.com/rust-lang/rust-bindgen/issues/3184
        #[cfg(not(target_os = "windows"))]
        {
            assert!(uri.is_initialized());
            assert!(!uri.dns_looked_up());
            assert!(!uri.dns_resolved());
        }
    }
}

// TODO(jelmer): Rather than serializing/deserializing, we should be able to just copy the fields
// over.
// Note: This impl cannot work without a pool parameter, so it's commented out
// #[cfg(feature = "url")]
// impl From<url::Url> for Uri {
//     fn from(url: url::Url) -> Self {
//         let s = url.as_str();
//         Self::parse(s).unwrap()
//     }
// }

#[cfg(feature = "url")]
impl<'a> From<Uri<'a>> for url::Url {
    fn from(uri: Uri<'a>) -> Self {
        let s = uri.unparse(0);
        url::Url::parse(&s).unwrap()
    }
}