safe_app 0.8.0

// Copyright 2018 MaidSafe.net limited.
//
// This SAFE Network Software is licensed to you under the MIT license <LICENSE-MIT
// http://opensource.org/licenses/MIT> or the Modified BSD license <LICENSE-BSD
// https://opensource.org/licenses/BSD-3-Clause>, at your option. This file may not be copied,
// modified, or distributed except according to those terms. Please review the Licences for the
// specific language governing permissions and limitations relating to use of the SAFE Network
// Software.

use ffi_utils::{catch_unwind_cb, from_c_str, FfiResult, OpaqueCtx, SafePtr, FFI_RESULT_OK};
use futures::Future;
use safe_core::ffi::ipc::req::ContainerPermissions;
use safe_core::ffi::MDataInfo;
use safe_core::ipc::req::containers_into_vec;
use safe_core::FutureExt;
use std::os::raw::{c_char, c_void};
use {App, AppError};

/// Fetch access info from the network.
///
/// Callback parameters: user data, error code
#[no_mangle]
pub unsafe extern "C" fn access_container_refresh_access_info(
    app: *const App,
    user_data: *mut c_void,
    o_cb: extern "C" fn(user_data: *mut c_void, result: *const FfiResult),
) {
    catch_unwind_cb(user_data, o_cb, || {
        let user_data = OpaqueCtx(user_data);

        (*app).send(move |client, context| {
            context
                .refresh_access_info(client)
                .then(move |res| {
                    call_result_cb!(res, user_data, o_cb);
                    Ok(())
                })
                .into_box()
                .into()
        })
    })
}

/// Retrieve a list of container names that an app has access to.
///
/// Callback parameters: user data, error code, container permissions vector, vector size
#[no_mangle]
pub unsafe extern "C" fn access_container_fetch(
    app: *const App,
    user_data: *mut c_void,
    o_cb: extern "C" fn(
        user_data: *mut c_void,
        result: *const FfiResult,
        container_perms: *const ContainerPermissions,
        container_perms_len: usize,
    ),
) {
    catch_unwind_cb(user_data, o_cb, || {
        let user_data = OpaqueCtx(user_data);

        (*app).send(move |client, context| {
            context
                .get_access_info(client)
                .and_then(move |containers| {
                    let ffi_containers = containers_into_vec(
                        containers.into_iter().map(|(key, (_, value))| (key, value)),
                    )?;
                    o_cb(
                        user_data.0,
                        FFI_RESULT_OK,
                        ffi_containers.as_safe_ptr(),
                        ffi_containers.len(),
                    );
                    Ok(())
                })
                .map_err(move |e| {
                    call_result_cb!(Err::<(), _>(e), user_data, o_cb);
                })
                .into_box()
                .into()
        })
    })
}

/// Retrieve `MDataInfo` for the given container name from the access container.
///
/// Callback parameters: user data, error code, mdata info handle
#[no_mangle]
pub unsafe extern "C" fn access_container_get_container_mdata_info(
    app: *const App,
    name: *const c_char,
    user_data: *mut c_void,
    o_cb: extern "C" fn(
        user_data: *mut c_void,
        result: *const FfiResult,
        mdata_info: *const MDataInfo,
    ),
) {
    catch_unwind_cb(user_data, o_cb, || {
        let user_data = OpaqueCtx(user_data);
        let name = from_c_str(name)?;

        (*app).send(move |client, context| {
            context
                .get_access_info(client)
                .map(move |mut containers| {
                    if let Some((mdata_info, _)) = containers.remove(&name) {
                        let mdata_info = mdata_info.into_repr_c();
                        o_cb(user_data.0, FFI_RESULT_OK, &mdata_info);
                    } else {
                        call_result_cb!(
                            Err::<(), _>(AppError::NoSuchContainer(name)),
                            user_data,
                            o_cb
                        );
                    }
                })
                .map_err(move |err| {
                    call_result_cb!(Err::<(), _>(err), user_data, o_cb);
                })
                .into_box()
                .into()
        })
    })
}

#[cfg(test)]
mod tests {
    use errors::AppError;
    use ffi::access_container::*;
    use ffi_utils::test_utils::{call_0, call_1, call_vec};
    use ffi_utils::{from_c_str, ReprC};
    use safe_core::ffi::ipc::req::ContainerPermissions as FfiContainerPermissions;
    use safe_core::ipc::req::ContainerPermissions;
    use safe_core::ipc::req::{container_perms_from_repr_c, Permission};
    use safe_core::{MDataInfo, DIR_TAG};
    use std::collections::HashMap;
    use std::ffi::CString;
    use std::rc::Rc;
    use test_utils::{create_app_by_req, create_auth_req_with_access, run};

    // Test refreshing access info by fetching it from the network.
    #[test]
    fn refresh_access_info() {
        // Shared container
        let mut container_permissions = HashMap::new();
        let _ = container_permissions.insert(
            "_videos".to_string(),
            btree_set![Permission::Read, Permission::Insert],
        );

        let app = unwrap!(create_app_by_req(&create_auth_req_with_access(
            container_permissions.clone()
        ),));

        run(&app, move |_client, context| {
            let reg = Rc::clone(unwrap!(context.as_registered()));
            assert!(reg.access_info.borrow().is_empty());
            Ok(())
        });

        unsafe {
            unwrap!(call_0(|ud, cb| access_container_refresh_access_info(
                &app, ud, cb
            ),))
        }

        run(&app, move |_client, context| {
            let reg = Rc::clone(unwrap!(context.as_registered()));
            assert!(!reg.access_info.borrow().is_empty());

            let access_info = reg.access_info.borrow();
            assert_eq!(
                unwrap!(access_info.get("_videos")).1,
                *unwrap!(container_permissions.get("_videos"))
            );

            Ok(())
        });
    }

    // Test getting info about access containers and their mutable data.
    #[test]
    fn get_access_info() {
        let mut container_permissions = HashMap::new();
        let _ = container_permissions.insert("_videos".to_string(), btree_set![Permission::Read]);
        let app = unwrap!(create_app_by_req(&create_auth_req_with_access(
            container_permissions
        ),));

        // Get access container info
        let perms: Vec<PermSet> =
            unsafe { unwrap!(call_vec(|ud, cb| access_container_fetch(&app, ud, cb))) };

        let perms: HashMap<_, _> = perms.into_iter().map(|val| (val.0, val.1)).collect();
        assert_eq!(perms["_videos"], btree_set![Permission::Read]);
        assert_eq!(perms.len(), 2);

        // Get MD info
        let md_info: MDataInfo = {
            let videos_str = unwrap!(CString::new("_videos"));
            unsafe {
                unwrap!(call_1(|ud, cb| access_container_get_container_mdata_info(
                    &app,
                    videos_str.as_ptr(),
                    ud,
                    cb
                )))
            }
        };

        assert_eq!(md_info.type_tag, DIR_TAG);
    }

    struct PermSet(String, ContainerPermissions);

    impl ReprC for PermSet {
        type C = *const FfiContainerPermissions;
        type Error = AppError;

        unsafe fn clone_from_repr_c(c_repr: Self::C) -> Result<Self, Self::Error> {
            Ok(PermSet(
                from_c_str((*c_repr).cont_name)?,
                container_perms_from_repr_c((*c_repr).access)?,
            ))
        }
    }

}