//! Declare the RPC session object as exposed from the RPC server run by the `arti` crate.

use arti_client::TorClient;

use arti_rpcserver::RpcAuthentication;

use derive_deftly::Deftly;

use futures::stream::StreamExt as _;

use std::sync::Arc;

use tor_async_utils::{DropNotifyEofSignallable, DropNotifyWatchSender};

use tor_rpc_connect::SuperuserPermission;

use tor_rpcbase::{self as rpc};

use tor_rtcompat::Runtime;

use crate::{

    proxy::port_info,

    reload_cfg::{CfgMgr, LaunchableTorClient},

    rpc::{listener::RpcConnInfo, superuser::RpcSuperuser},

};

use super::proxyinfo::{self, ProxyInfo};

/// A top-level RPC session object.

///

/// This is the first object that an RPC user receives upon authenticating;

/// It is returned by `auth:authenticate`.

///

/// Other objects (`TorClient`,`RpcDataStream`, etc)

/// are available using methods on this object.

/// (See the list of available methods.)

///

/// This type wraps and delegates to [`arti_rpcserver::RpcSession`],

/// but exposes additional functionality not available at the

/// level of [`arti_rpcserver`], including information about configured proxies.

///

/// This ObjectID for this object can be used as the target of a SOCKS stream.

#[derive(Deftly)]

#[derive_deftly(rpc::Object)]

#[deftly(rpc(

    delegate_with = "|this: &Self| Some(this.session.clone())",

    delegate_type = "arti_rpcserver::RpcSession"

))]

#[deftly(rpc(expose_outside_of_session))]

pub(super) struct ArtiRpcSession {

    /// State about the `arti` server, as seen by the Rpc system.

    pub(super) arti_state: Arc<RpcVisibleArtiState>,

    /// The underlying RpcSession object that we delegate to.

    session: Arc<arti_rpcserver::RpcSession>,

}

/// Information about the current global top-level Arti state,

/// as exposed to an Rpc Session.

//

// TODO: This type is dangerously close to being a collection of globals.

// We should refactor it aggressively when we refactor the `arti` crate.

//

// TODO: Right now this is constructed in the same form that it's used in

// ArtiRpcSession.  Later on, we could split it into one type that

// the rest of this crate constructs, and another type that the

// ArtiRpcSession actually uses. We should do that if the needs seem to diverge.

pub(crate) struct RpcVisibleArtiState {

    /// A `ProxyInfo` that we hand out when asked to list our proxy ports.

    ///

    /// Right now it only lists Socks; in the future it may list more.

    proxy_info: postage::watch::Receiver<ProxyInfoState>,

}

/// Handle to set RPC state across RPC sessions.  (See `RpcVisibleArtiState`.)

#[derive(Debug)]

pub(crate) struct RpcStateSender {

    /// Sender for setting our list of proxy ports.

    proxy_info_sender: DropNotifyWatchSender<ProxyInfoState>,

}

impl ArtiRpcSession {

    /// Construct a new `ArtiRpcSession`.

    ///

    /// Privileges on the session (if any) are derived from `auth`, which describes

    /// how the user authenticated.

    ///

    /// The session receives a new isolated TorClient, based on `client_root`.

}

/// Possible state for a watched proxy_info.

#[derive(Debug, Clone)]

enum ProxyInfoState {

    /// We haven't set it yet.

    Unset,

    /// We've set it to a given value.

    Set(Arc<ProxyInfo>),

    /// The sender has been dropped.

    Eof,

}

impl DropNotifyEofSignallable for ProxyInfoState {

}

impl RpcVisibleArtiState {

    /// Construct a new `RpcVisibleArtiState`.

    /// Return the latest proxy info, waiting until it is set.

    ///

    /// Return an error if the sender has been closed.

            }

        }

}

impl RpcStateSender {

    /// Set the list of stream listener addresses on this state.

    ///

    /// This method may only be called once per state.

                    Some(proxyinfo::Proxy {

                    })

        };

}

#[cfg(test)]

mod test {

    // @@ begin test lint list maintained by maint/add_warning @@

    #![allow(clippy::bool_assert_comparison)]

    #![allow(clippy::clone_on_copy)]

    #![allow(clippy::dbg_macro)]

    #![allow(clippy::mixed_attributes_style)]

    #![allow(clippy::print_stderr)]

    #![allow(clippy::print_stdout)]

    #![allow(clippy::single_char_pattern)]

    #![allow(clippy::unwrap_used)]

    #![allow(clippy::unchecked_time_subtraction)]

    #![allow(clippy::useless_vec)]

    #![allow(clippy::needless_pass_by_value)]

    #![allow(clippy::string_slice)] // See arti#2571

    //! <!-- @@ end test lint list maintained by maint/add_warning @@ -->

    use tor_rtcompat::SpawnExt as _;

    use tor_rtmock::MockRuntime;

    use super::*;

    #[test]

    fn set_proxy_info() {

        MockRuntime::test_with_various(|rt| async move {

            let (state, mut sender) = RpcVisibleArtiState::new();

            let _task = rt.clone().spawn_with_handle(async move {

                sender.set_stream_listeners(&[port_info::Port {

                    protocol: port_info::SupportedProtocol::Socks,

                    address: "8.8.8.8:40".parse().unwrap(),

                }]);

                sender // keep sender alive

            });

            let value = state.get_proxy_info().await;

            // At this point, we've returned once, so this will test that we get a fresh answer even

            // if we already set the inner value.

            let value_again = state.get_proxy_info().await;

            assert_eq!(value.unwrap(), value_again.unwrap());

        });

    }

}