// This file was generated by gir (https://github.com/gtk-rs/gir)
// from
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::ServerMessage;
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// Server-side authentication.
    ///
    /// A #SoupAuthDomain manages authentication for all or part of a
    /// [`Server`][crate::Server]. To make a server require authentication, first create
    /// an appropriate subclass of #SoupAuthDomain, and then add it to the
    /// server with [`ServerExt::add_auth_domain()`][crate::prelude::ServerExt::add_auth_domain()].
    ///
    /// In order for an auth domain to have any effect, you must add one or more
    /// paths to it (via [`AuthDomainExt::add_path()`][crate::prelude::AuthDomainExt::add_path()]). To require authentication for
    /// all ordinary requests, add the path `"/"`. (Note that this does not include
    /// the special `"*"` URI (eg, "OPTIONS *"), which must be added as a separate
    /// path if you want to cover it.)
    ///
    /// If you need greater control over which requests should and shouldn't be
    /// authenticated, add paths covering everything you *might* want authenticated,
    /// and then use a filter ([`AuthDomainExt::set_filter()`][crate::prelude::AuthDomainExt::set_filter()] to bypass
    /// authentication for those requests that don't need it.
    ///
    /// This is an Abstract Base Class, you cannot instantiate it.
    ///
    /// ## Properties
    ///
    ///
    /// #### `filter`
    ///  The `callback::AuthDomainFilter for the domain.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `filter-data`
    ///  Data to pass to the `callback::AuthDomainFilter.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `generic-auth-callback`
    ///  The `callback::AuthDomainGenericAuthCallback.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `generic-auth-data`
    ///  The data to pass to the `callback::AuthDomainGenericAuthCallback.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `proxy`
    ///  Whether or not this is a proxy auth domain.
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `realm`
    ///  The realm of this auth domain.
    ///
    /// Readable | Writeable | Construct Only
    ///
    /// # Implements
    ///
    /// [`AuthDomainExt`][trait@crate::prelude::AuthDomainExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "SoupAuthDomain")]
    pub struct AuthDomain(Object<ffi::SoupAuthDomain, ffi::SoupAuthDomainClass>);

    match fn {
        type_ => || ffi::soup_auth_domain_get_type(),
    }
}

impl AuthDomain {
    pub const NONE: Option<&'static AuthDomain> = None;
}

mod sealed {
    pub trait Sealed {}
    impl<T: super::IsA<super::AuthDomain>> Sealed for T {}
}

/// Trait containing all [`struct@AuthDomain`] methods.
///
/// # Implementors
///
/// [`AuthDomainBasic`][struct@crate::AuthDomainBasic], [`AuthDomainDigest`][struct@crate::AuthDomainDigest], [`AuthDomain`][struct@crate::AuthDomain]
pub trait AuthDomainExt: IsA<AuthDomain> + sealed::Sealed + 'static {
    /// Checks if @msg contains appropriate authorization for @self to
    /// accept it.
    ///
    /// Mirroring [`covers()`][Self::covers()], this does not check whether or not
    /// @self *cares* if @msg is authorized.
    ///
    /// This is used by [`Server`][crate::Server] internally and is probably of no use to
    /// anyone else.
    /// ## `msg`
    /// a #SoupServerMessage
    ///
    /// # Returns
    ///
    /// the username that @msg has authenticated
    ///   as, if in fact it has authenticated. [`None`] otherwise.
    #[doc(alias = "soup_auth_domain_accepts")]
    fn accepts(&self, msg: &ServerMessage) -> Option<glib::GString> {
        unsafe {
            from_glib_full(ffi::soup_auth_domain_accepts(
                self.as_ref().to_glib_none().0,
                msg.to_glib_none().0,
            ))
        }
    }

    /// Adds @path to @self.
    ///
    /// Requests under @path on @self's server will require authentication (unless
    /// overridden by [`remove_path()`][Self::remove_path()] or
    /// [`set_filter()`][Self::set_filter()]).
    /// ## `path`
    /// the path to add to @self
    #[doc(alias = "soup_auth_domain_add_path")]
    fn add_path(&self, path: &str) {
        unsafe {
            ffi::soup_auth_domain_add_path(self.as_ref().to_glib_none().0, path.to_glib_none().0);
        }
    }

    /// Adds a "WWW-Authenticate" or "Proxy-Authenticate" header to @msg.
    ///
    /// It requests that the client authenticate, and sets @msg's status accordingly.
    ///
    /// This is used by [`Server`][crate::Server] internally and is probably of no use to
    /// anyone else.
    /// ## `msg`
    /// a #SoupServerMessage
    #[doc(alias = "soup_auth_domain_challenge")]
    fn challenge(&self, msg: &ServerMessage) {
        unsafe {
            ffi::soup_auth_domain_challenge(self.as_ref().to_glib_none().0, msg.to_glib_none().0);
        }
    }

    /// Checks if @msg authenticates to @self via @username and
    /// @password.
    ///
    /// This would normally be called from a
    /// `callback::AuthDomainGenericAuthCallback.
    /// ## `msg`
    /// a #SoupServerMessage
    /// ## `username`
    /// a username
    /// ## `password`
    /// a password
    ///
    /// # Returns
    ///
    /// whether or not the message is authenticated
    #[doc(alias = "soup_auth_domain_check_password")]
    fn check_password(&self, msg: &ServerMessage, username: &str, password: &str) -> bool {
        unsafe {
            from_glib(ffi::soup_auth_domain_check_password(
                self.as_ref().to_glib_none().0,
                msg.to_glib_none().0,
                username.to_glib_none().0,
                password.to_glib_none().0,
            ))
        }
    }

    /// Checks if @self requires @msg to be authenticated (according to
    /// its paths and filter function).
    ///
    /// This does not actually look at whether @msg *is* authenticated, merely
    /// whether or not it needs to be.
    ///
    /// This is used by [`Server`][crate::Server] internally and is probably of no use to
    /// anyone else.
    /// ## `msg`
    /// a #SoupServerMessage
    ///
    /// # Returns
    ///
    /// [`true`] if @self requires @msg to be authenticated
    #[doc(alias = "soup_auth_domain_covers")]
    fn covers(&self, msg: &ServerMessage) -> bool {
        unsafe {
            from_glib(ffi::soup_auth_domain_covers(
                self.as_ref().to_glib_none().0,
                msg.to_glib_none().0,
            ))
        }
    }

    /// Gets the realm name associated with @self.
    ///
    /// # Returns
    ///
    /// @self's realm
    #[doc(alias = "soup_auth_domain_get_realm")]
    #[doc(alias = "get_realm")]
    fn realm(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::soup_auth_domain_get_realm(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Removes @path from @self.
    ///
    /// Requests under @path on @self's server will NOT require
    /// authentication.
    ///
    /// This is not simply an undo-er for [`add_path()`][Self::add_path()]; it
    /// can be used to "carve out" a subtree that does not require
    /// authentication inside a hierarchy that does. Note also that unlike
    /// with [`add_path()`][Self::add_path()], this cannot be overridden by
    /// adding a filter, as filters can only bypass authentication that
    /// would otherwise be required, not require it where it would
    /// otherwise be unnecessary.
    /// ## `path`
    /// the path to remove from @self
    #[doc(alias = "soup_auth_domain_remove_path")]
    fn remove_path(&self, path: &str) {
        unsafe {
            ffi::soup_auth_domain_remove_path(
                self.as_ref().to_glib_none().0,
                path.to_glib_none().0,
            );
        }
    }

    /// Adds @filter as an authentication filter to @self.
    ///
    /// The filter gets a chance to bypass authentication for certain requests that
    /// would otherwise require it. Eg, it might check the message's path in some way
    /// that is too complicated to do via the other methods, or it might check the
    /// message's method, and allow GETs but not PUTs.
    ///
    /// The filter function returns [`true`] if the request should still
    /// require authentication, or [`false`] if authentication is unnecessary
    /// for this request.
    ///
    /// To help prevent security holes, your filter should return [`true`] by
    /// default, and only return [`false`] under specifically-tested
    /// circumstances, rather than the other way around. Eg, in the example
    /// above, where you want to authenticate PUTs but not GETs, you should
    /// check if the method is GET and return [`false`] in that case, and then
    /// return [`true`] for all other methods (rather than returning [`true`] for
    /// PUT and [`false`] for all other methods). This way if it turned out
    /// (now or later) that some paths supported additional methods besides
    /// GET and PUT, those methods would default to being NOT allowed for
    /// unauthenticated users.
    ///
    /// You can also set the filter by setting the SoupAuthDomain:filter
    /// and [`filter-data`][struct@crate::AuthDomain#filter-data] properties], which can also be
    /// used to set the filter at construct time.
    /// ## `filter`
    /// the auth filter for @self
    /// ## `filter_data`
    /// data to pass to @filter
    #[doc(alias = "soup_auth_domain_set_filter")]
    fn set_filter<P: Fn(&AuthDomain, &ServerMessage) -> bool + 'static>(&self, filter: P) {
        let filter_data: Box_<P> = Box_::new(filter);
        unsafe extern "C" fn filter_func<P: Fn(&AuthDomain, &ServerMessage) -> bool + 'static>(
            domain: *mut ffi::SoupAuthDomain,
            msg: *mut ffi::SoupServerMessage,
            user_data: glib::ffi::gpointer,
        ) -> glib::ffi::gboolean {
            let domain = from_glib_borrow(domain);
            let msg = from_glib_borrow(msg);
            let callback = &*(user_data as *mut P);
            (*callback)(&domain, &msg).into_glib()
        }
        let filter = Some(filter_func::<P> as _);
        unsafe extern "C" fn dnotify_func<P: Fn(&AuthDomain, &ServerMessage) -> bool + 'static>(
            data: glib::ffi::gpointer,
        ) {
            let _callback = Box_::from_raw(data as *mut P);
        }
        let destroy_call3 = Some(dnotify_func::<P> as _);
        let super_callback0: Box_<P> = filter_data;
        unsafe {
            ffi::soup_auth_domain_set_filter(
                self.as_ref().to_glib_none().0,
                filter,
                Box_::into_raw(super_callback0) as *mut _,
                destroy_call3,
            );
        }
    }

    /// Sets @auth_callback as an authentication-handling callback for @self.
    ///
    /// Whenever a request comes in to @self which cannot be authenticated via a
    /// domain-specific auth callback (eg, `callback::AuthDomainDigestAuthCallback),
    /// the generic auth callback will be invoked. See
    /// `callback::AuthDomainGenericAuthCallback for information on what the callback
    /// should do.
    /// ## `auth_callback`
    /// the auth callback
    /// ## `auth_data`
    /// data to pass to @auth_callback
    #[doc(alias = "soup_auth_domain_set_generic_auth_callback")]
    fn set_generic_auth_callback<P: Fn(&AuthDomain, &ServerMessage, &str) -> bool + 'static>(
        &self,
        auth_callback: P,
    ) {
        let auth_callback_data: Box_<P> = Box_::new(auth_callback);
        unsafe extern "C" fn auth_callback_func<
            P: Fn(&AuthDomain, &ServerMessage, &str) -> bool + 'static,
        >(
            domain: *mut ffi::SoupAuthDomain,
            msg: *mut ffi::SoupServerMessage,
            username: *const libc::c_char,
            user_data: glib::ffi::gpointer,
        ) -> glib::ffi::gboolean {
            let domain = from_glib_borrow(domain);
            let msg = from_glib_borrow(msg);
            let username: Borrowed<glib::GString> = from_glib_borrow(username);
            let callback = &*(user_data as *mut P);
            (*callback)(&domain, &msg, username.as_str()).into_glib()
        }
        let auth_callback = Some(auth_callback_func::<P> as _);
        unsafe extern "C" fn dnotify_func<
            P: Fn(&AuthDomain, &ServerMessage, &str) -> bool + 'static,
        >(
            data: glib::ffi::gpointer,
        ) {
            let _callback = Box_::from_raw(data as *mut P);
        }
        let destroy_call3 = Some(dnotify_func::<P> as _);
        let super_callback0: Box_<P> = auth_callback_data;
        unsafe {
            ffi::soup_auth_domain_set_generic_auth_callback(
                self.as_ref().to_glib_none().0,
                auth_callback,
                Box_::into_raw(super_callback0) as *mut _,
                destroy_call3,
            );
        }
    }

    //#[doc(alias = "filter-data")]
    //fn filter_data(&self) -> /*Unimplemented*/Basic: Pointer {
    //    ObjectExt::property(self.as_ref(), "filter-data")
    //}

    //#[doc(alias = "filter-data")]
    //fn set_filter_data(&self, filter_data: /*Unimplemented*/Basic: Pointer) {
    //    ObjectExt::set_property(self.as_ref(),"filter-data", filter_data)
    //}

    //#[doc(alias = "generic-auth-data")]
    //fn generic_auth_data(&self) -> /*Unimplemented*/Basic: Pointer {
    //    ObjectExt::property(self.as_ref(), "generic-auth-data")
    //}

    //#[doc(alias = "generic-auth-data")]
    //fn set_generic_auth_data(&self, generic_auth_data: /*Unimplemented*/Basic: Pointer) {
    //    ObjectExt::set_property(self.as_ref(),"generic-auth-data", generic_auth_data)
    //}

    /// Whether or not this is a proxy auth domain.
    fn is_proxy(&self) -> bool {
        ObjectExt::property(self.as_ref(), "proxy")
    }

    #[doc(alias = "filter-data")]
    fn connect_filter_data_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_filter_data_trampoline<
            P: IsA<AuthDomain>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::SoupAuthDomain,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(AuthDomain::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::filter-data\0".as_ptr() as *const _,
                Some(std::mem::transmute::<_, unsafe extern "C" fn()>(
                    notify_filter_data_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "generic-auth-data")]
    fn connect_generic_auth_data_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_generic_auth_data_trampoline<
            P: IsA<AuthDomain>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::SoupAuthDomain,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(AuthDomain::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"notify::generic-auth-data\0".as_ptr() as *const _,
                Some(std::mem::transmute::<_, unsafe extern "C" fn()>(
                    notify_generic_auth_data_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<AuthDomain>> AuthDomainExt for O {}