Diff
Not logged in

Differences From Artifact [f8c8f60eb7]:

To Artifact [29803d5215]:


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19


20
21
22
23
24
25
26
27
28
29
30
31

32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
..
97
98
99
100
101
102
103
104
105
106
107

108
109
110
111
112

113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
...
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169


170
171
172
173
174
175
176

177
178
179
180
181
182
183
184
...
207
208
209
210
211
212
213
214

215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
...
304
305
306
307
308
309
310

311
312
313
314
315
316
317
318

319
320
321
322
323
324
325
326
327
328


329
330
331
332
333
334
335
// Copyright 2016 MaidSafe.net limited.
//
// This SAFE Network Software is licensed to you under (1) the MaidSafe.net Commercial License,
// version 1.0 or later, or (2) The General Public License (GPL), version 3, depending on which
// licence you accepted on initial access to the Software (the "Licences").
//
// By contributing code to the SAFE Network Software, or to this project generally, you agree to be
// bound by the terms of the MaidSafe Contributor Agreement, version 1.0.  This, along with the
// Licenses can be found in the root directory of this project at LICENSE, COPYING and CONTRIBUTOR.
//
// Unless required by applicable law or agreed to in writing, the SAFE Network Software distributed
// under the GPL Licence is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.
//
// Please review the Licences for the specific language governing permissions and limitations
// relating to use of the SAFE Network Software.

//! Session management



use core::client::Client;
use core::translated_events::NetworkEvent;
use libc::{int32_t, int64_t};
use maidsafe_utilities::thread::{self, Joiner};
use nfs::metadata::directory_key::DirectoryKey;
use std::ptr;
use std::sync::{Arc, Mutex};
use std::sync::mpsc::{self, Sender};
use super::errors::FfiError;
use super::helper;

/// Represents user session on the SAFE network. There should be one session per launcher.

pub struct Session {
    client: Arc<Mutex<Client>>,
    safe_drive_dir_key: Option<DirectoryKey>,

    network_event_observers: Arc<Mutex<Vec<extern "C" fn(i32)>>>,
    network_thread: Option<(Sender<NetworkEvent>, Joiner)>,
}

impl Session {
    /// Create unregistered client.
    pub fn create_unregistered_client() -> Result<Self, FfiError> {
        let client = try!(Client::create_unregistered_client());
        let client = Arc::new(Mutex::new(client));

        Ok(Session {
            client: client,
            safe_drive_dir_key: None,
            network_event_observers: Default::default(),
            network_thread: None,
        })
    }

    /// Create new account.
    pub fn create_account(locator: &str, password: &str) -> Result<Self, FfiError> {



        let client = try!(Client::create_account(locator, password));
        let client = Arc::new(Mutex::new(client));

        let safe_drive_dir_key = try!(helper::get_safe_drive_key(client.clone()));

        Ok(Session {
            client: client,
            safe_drive_dir_key: Some(safe_drive_dir_key),
            network_event_observers: Default::default(),
            network_thread: None,
        })
    }

    /// Log in to existing account.
    pub fn log_in(locator: &str, password: &str) -> Result<Self, FfiError> {
        let client = try!(Client::log_in(locator, password));
        let client = Arc::new(Mutex::new(client));

        let safe_drive_dir_key = try!(helper::get_safe_drive_key(client.clone()));

        Ok(Session {
            client: client,
            safe_drive_dir_key: Some(safe_drive_dir_key),
            network_event_observers: Default::default(),
            network_thread: None,
        })
    }

    /// Get the client.
    pub fn get_client(&self) -> Arc<Mutex<Client>> {
        self.client.clone()
    }

................................................................................
        if self.network_thread.is_none() {
            let callbacks = self.network_event_observers.clone();

            let (tx, rx) = mpsc::channel();
            let cloned_tx = tx.clone();
            unwrap!(self.client.lock()).add_network_event_observer(tx);

            let joiner = thread::named("FfiNetworkEventObserver", move || {
                while let Ok(event) = rx.recv() {
                    if let NetworkEvent::Terminated = event {
                        trace!("FFI exiting the network event notifier thread.");

                        break;
                    }

                    let callbacks = &*unwrap!(callbacks.lock());
                    info!("Informing {:?} to {} FFI network event observers.",

                          event,
                          callbacks.len());
                    let event_ffi_val = event.into();

                    for cb in callbacks {
                        cb(event_ffi_val);
                    }
                }
            });

            self.network_thread = Some((cloned_tx, joiner));
        }
    }

    fn get_account_info(&self) -> Result<(u64, u64), FfiError> {
        let mut client = unwrap!(self.client.lock());
        let getter = try!(client.get_account_info(None));
        Ok(try!(getter.get()))
    }
}

impl Drop for Session {
    fn drop(&mut self) {
        debug!("Session is now being dropped.");

................................................................................

/// Create a session as an unregistered client. This or any one of the other companion functions to
/// get a session must be called before initiating any operation allowed by this crate.
#[no_mangle]
pub unsafe extern "C" fn create_unregistered_client(session_handle: *mut *mut SessionHandle)
                                                    -> int32_t {
    helper::catch_unwind_i32(|| {
        trace!("FFI create unregistered client.");

        let session = ffi_try!(Session::create_unregistered_client());
        *session_handle = allocate_handle(session);
        0
    })
}

/// Create a registered client. This or any one of the other companion functions to get a
/// session must be called before initiating any operation allowed by this crate. `session_handle`
/// is a pointer to a pointer and must point to a valid pointer not junk, else the consequences are
/// undefined.
#[no_mangle]
pub unsafe extern "C" fn create_account(account_locator: *const u8,
                                        account_locator_len: usize,
                                        account_password: *const u8,
                                        account_password_len: usize,


                                        session_handle: *mut *mut SessionHandle)
                                        -> int32_t {
    helper::catch_unwind_i32(|| {
        trace!("FFI create a client account.");

        let acc_locator = ffi_try!(helper::c_utf8_to_str(account_locator, account_locator_len));
        let acc_password = ffi_try!(helper::c_utf8_to_str(account_password, account_password_len));

        let session = ffi_try!(Session::create_account(acc_locator, acc_password));

        *session_handle = allocate_handle(session);
        0
    })
}

/// Log into a registered client. This or any one of the other companion functions to get a
................................................................................
/// Register an observer to network events like Connected, Disconnected etc. as provided by the
/// core module
#[no_mangle]
pub unsafe extern "C" fn register_network_event_observer(session_handle: *mut SessionHandle,
                                                         callback: extern "C" fn(i32))
                                                         -> int32_t {
    helper::catch_unwind_i32(|| {
        trace!("FFI register a network event observer.");

        unwrap!((*session_handle).lock()).register_network_event_observer(callback);
        0
    })
}


/// Return the amount of calls that were done to `get`
#[no_mangle]
pub unsafe extern "C" fn client_issued_gets(session_handle: *const SessionHandle) -> int64_t {
    helper::catch_unwind_i64(|| {
        trace!("FFI retrieve client issued GETs.");
        let session = unwrap!((*session_handle).lock());
        let client = unwrap!(session.client.lock());
        client.issued_gets() as int64_t
    })
}

/// Return the amount of calls that were done to `put`
#[no_mangle]
pub unsafe extern "C" fn client_issued_puts(session_handle: *const SessionHandle) -> int64_t {
    helper::catch_unwind_i64(|| {
        trace!("FFI retrieve client issued PUTs.");
        let session = unwrap!((*session_handle).lock());
        let client = unwrap!(session.client.lock());
        client.issued_puts() as int64_t
    })
}

/// Return the amount of calls that were done to `post`
#[no_mangle]
pub unsafe extern "C" fn client_issued_posts(session_handle: *const SessionHandle) -> int64_t {
    helper::catch_unwind_i64(|| {
        trace!("FFI retrieve client issued POSTs.");
        let session = unwrap!((*session_handle).lock());
        let client = unwrap!(session.client.lock());
        client.issued_posts() as int64_t
    })
}

/// Return the amount of calls that were done to `delete`
#[no_mangle]
pub unsafe extern "C" fn client_issued_deletes(session_handle: *const SessionHandle) -> int64_t {
    helper::catch_unwind_i64(|| {
        trace!("FFI retrieve client issued DELETEs.");
        let session = unwrap!((*session_handle).lock());
        let client = unwrap!(session.client.lock());
        client.issued_deletes() as int64_t
    })
}

/// Return the amount of calls that were done to `append`
#[no_mangle]
pub unsafe extern "C" fn client_issued_appends(session_handle: *const SessionHandle) -> int64_t {
    helper::catch_unwind_i64(|| {
        trace!("FFI retrieve client issued APPENDs.");
        let session = unwrap!((*session_handle).lock());
        let client = unwrap!(session.client.lock());
        client.issued_appends() as int64_t
    })
}

/// Get data from the network. This is non-blocking. `data_stored` means number
/// of chunks Put. `space_available` means number of chunks which can still be
/// Put.
#[no_mangle]
pub unsafe extern "C" fn get_account_info(session_handle: *const SessionHandle,
................................................................................

unsafe fn allocate_handle(session: Session) -> *mut SessionHandle {
    Box::into_raw(Box::new(Arc::new(Mutex::new(session))))
}

#[cfg(test)]
mod test {

    use ffi::test_utils;
    use std::ptr;
    use super::*;

    #[test]
    fn create_account_and_log_in() {
        let acc_locator = test_utils::generate_random_cstring(10);
        let acc_password = test_utils::generate_random_cstring(10);


        {
            let mut session_handle: *mut SessionHandle = ptr::null_mut();

            unsafe {
                let session_handle_ptr = &mut session_handle;

                assert_eq!(create_account(acc_locator.as_ptr() as *const u8,
                                          10,
                                          acc_password.as_ptr() as *const u8,


                                          10,
                                          session_handle_ptr),
                           0);
            }

            assert!(!session_handle.is_null());
            unsafe { drop_session(session_handle) };







|
|










>
>








<
<


>











|



|
|
|
|
|



|
>
>
>
|


|


|
|
|
|
|




|


|


|
|
|
|
|







 







|
|
|
|
>
|
|

|
|
>
|
|
|

|
|
|
<
|







|
|







 







|

|
|
|
|











>
>







>
|







 







|
>
|
|
|







|
|
|
|
|






|
|
|
|
|






|
|
|
|
|






|
|
|
|
|






|
|
|
|
|







 







>


<





>










>
>







1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29


30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
...
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
...
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
...
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
...
313
314
315
316
317
318
319
320
321
322

323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
// Copyright 2016 MaidSafe.net limited.
//
// This SAFE Network Software is licensed to you under (1) the MaidSafe.net Commercial License,
// version 1.0 or later, or (2) The General Public License (GPL), version 3, depending on which
// licence you accepted on initial access to the Software (the "Licences").
//
// By contributing code to the SAFE Network Software, or to this project generally, you agree to be
// bound by the terms of the MaidSafe Contributor Agreement.  This, along with the Licenses can be
// found in the root directory of this project at LICENSE, COPYING and CONTRIBUTOR.
//
// Unless required by applicable law or agreed to in writing, the SAFE Network Software distributed
// under the GPL Licence is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.
//
// Please review the Licences for the specific language governing permissions and limitations
// relating to use of the SAFE Network Software.

//! Session management

use super::errors::FfiError;
use super::helper;
use core::client::Client;
use core::translated_events::NetworkEvent;
use libc::{int32_t, int64_t};
use maidsafe_utilities::thread::{self, Joiner};
use nfs::metadata::directory_key::DirectoryKey;
use std::ptr;
use std::sync::{Arc, Mutex};
use std::sync::mpsc::{self, Sender};



/// Represents user session on the SAFE network. There should be one session per launcher.
#[cfg_attr(feature="cargo-clippy", allow(type_complexity))]
pub struct Session {
    client: Arc<Mutex<Client>>,
    safe_drive_dir_key: Option<DirectoryKey>,

    network_event_observers: Arc<Mutex<Vec<extern "C" fn(i32)>>>,
    network_thread: Option<(Sender<NetworkEvent>, Joiner)>,
}

impl Session {
    /// Create unregistered client.
    pub fn create_unregistered_client() -> Result<Self, FfiError> {
        let client = Client::create_unregistered_client()?;
        let client = Arc::new(Mutex::new(client));

        Ok(Session {
               client: client,
               safe_drive_dir_key: None,
               network_event_observers: Default::default(),
               network_thread: None,
           })
    }

    /// Create new account.
    pub fn create_account(locator: &str,
                          password: &str,
                          invitation: &str)
                          -> Result<Self, FfiError> {
        let client = Client::create_account(locator, password, invitation)?;
        let client = Arc::new(Mutex::new(client));

        let safe_drive_dir_key = helper::get_safe_drive_key(client.clone())?;

        Ok(Session {
               client: client,
               safe_drive_dir_key: Some(safe_drive_dir_key),
               network_event_observers: Default::default(),
               network_thread: None,
           })
    }

    /// Log in to existing account.
    pub fn log_in(locator: &str, password: &str) -> Result<Self, FfiError> {
        let client = Client::log_in(locator, password)?;
        let client = Arc::new(Mutex::new(client));

        let safe_drive_dir_key = helper::get_safe_drive_key(client.clone())?;

        Ok(Session {
               client: client,
               safe_drive_dir_key: Some(safe_drive_dir_key),
               network_event_observers: Default::default(),
               network_thread: None,
           })
    }

    /// Get the client.
    pub fn get_client(&self) -> Arc<Mutex<Client>> {
        self.client.clone()
    }

................................................................................
        if self.network_thread.is_none() {
            let callbacks = self.network_event_observers.clone();

            let (tx, rx) = mpsc::channel();
            let cloned_tx = tx.clone();
            unwrap!(self.client.lock()).add_network_event_observer(tx);

            let joiner = thread::named("FfiNetworkEventObserver",
                                       move || while let Ok(event) = rx.recv() {
                                           if let NetworkEvent::Terminated = event {
                                               trace!("FFI exiting the network event notifier /
                                                       thread.");
                                               break;
                                           }

                                           let callbacks = &*unwrap!(callbacks.lock());
                                           info!("Informing {:?} to {} FFI network event /
                                                  observers.",
                                                 event,
                                                 callbacks.len());
                                           let event_ffi_val = event.into();

                                           for cb in callbacks {
                                               cb(event_ffi_val);
                                           }

                                       });

            self.network_thread = Some((cloned_tx, joiner));
        }
    }

    fn get_account_info(&self) -> Result<(u64, u64), FfiError> {
        let mut client = unwrap!(self.client.lock());
        let getter = client.get_account_info(None)?;
        Ok(getter.get()?)
    }
}

impl Drop for Session {
    fn drop(&mut self) {
        debug!("Session is now being dropped.");

................................................................................

/// Create a session as an unregistered client. This or any one of the other companion functions to
/// get a session must be called before initiating any operation allowed by this crate.
#[no_mangle]
pub unsafe extern "C" fn create_unregistered_client(session_handle: *mut *mut SessionHandle)
                                                    -> int32_t {
    helper::catch_unwind_i32(|| {
                                 trace!("FFI create unregistered client.");

                                 let session = ffi_try!(Session::create_unregistered_client());
                                 *session_handle = allocate_handle(session);
                                 0
                             })
}

/// Create a registered client. This or any one of the other companion functions to get a
/// session must be called before initiating any operation allowed by this crate. `session_handle`
/// is a pointer to a pointer and must point to a valid pointer not junk, else the consequences are
/// undefined.
#[no_mangle]
pub unsafe extern "C" fn create_account(account_locator: *const u8,
                                        account_locator_len: usize,
                                        account_password: *const u8,
                                        account_password_len: usize,
                                        invitation: *const u8,
                                        invitation_len: usize,
                                        session_handle: *mut *mut SessionHandle)
                                        -> int32_t {
    helper::catch_unwind_i32(|| {
        trace!("FFI create a client account.");

        let acc_locator = ffi_try!(helper::c_utf8_to_str(account_locator, account_locator_len));
        let acc_password = ffi_try!(helper::c_utf8_to_str(account_password, account_password_len));
        let invitation = ffi_try!(helper::c_utf8_to_str(invitation, invitation_len));
        let session = ffi_try!(Session::create_account(acc_locator, acc_password, invitation));

        *session_handle = allocate_handle(session);
        0
    })
}

/// Log into a registered client. This or any one of the other companion functions to get a
................................................................................
/// Register an observer to network events like Connected, Disconnected etc. as provided by the
/// core module
#[no_mangle]
pub unsafe extern "C" fn register_network_event_observer(session_handle: *mut SessionHandle,
                                                         callback: extern "C" fn(i32))
                                                         -> int32_t {
    helper::catch_unwind_i32(|| {
                                 trace!("FFI register a network event observer.");
                                 unwrap!((*session_handle).lock())
                                     .register_network_event_observer(callback);
                                 0
                             })
}


/// Return the amount of calls that were done to `get`
#[no_mangle]
pub unsafe extern "C" fn client_issued_gets(session_handle: *const SessionHandle) -> int64_t {
    helper::catch_unwind_i64(|| {
                                 trace!("FFI retrieve client issued GETs.");
                                 let session = unwrap!((*session_handle).lock());
                                 let client = unwrap!(session.client.lock());
                                 client.issued_gets() as int64_t
                             })
}

/// Return the amount of calls that were done to `put`
#[no_mangle]
pub unsafe extern "C" fn client_issued_puts(session_handle: *const SessionHandle) -> int64_t {
    helper::catch_unwind_i64(|| {
                                 trace!("FFI retrieve client issued PUTs.");
                                 let session = unwrap!((*session_handle).lock());
                                 let client = unwrap!(session.client.lock());
                                 client.issued_puts() as int64_t
                             })
}

/// Return the amount of calls that were done to `post`
#[no_mangle]
pub unsafe extern "C" fn client_issued_posts(session_handle: *const SessionHandle) -> int64_t {
    helper::catch_unwind_i64(|| {
                                 trace!("FFI retrieve client issued POSTs.");
                                 let session = unwrap!((*session_handle).lock());
                                 let client = unwrap!(session.client.lock());
                                 client.issued_posts() as int64_t
                             })
}

/// Return the amount of calls that were done to `delete`
#[no_mangle]
pub unsafe extern "C" fn client_issued_deletes(session_handle: *const SessionHandle) -> int64_t {
    helper::catch_unwind_i64(|| {
                                 trace!("FFI retrieve client issued DELETEs.");
                                 let session = unwrap!((*session_handle).lock());
                                 let client = unwrap!(session.client.lock());
                                 client.issued_deletes() as int64_t
                             })
}

/// Return the amount of calls that were done to `append`
#[no_mangle]
pub unsafe extern "C" fn client_issued_appends(session_handle: *const SessionHandle) -> int64_t {
    helper::catch_unwind_i64(|| {
                                 trace!("FFI retrieve client issued APPENDs.");
                                 let session = unwrap!((*session_handle).lock());
                                 let client = unwrap!(session.client.lock());
                                 client.issued_appends() as int64_t
                             })
}

/// Get data from the network. This is non-blocking. `data_stored` means number
/// of chunks Put. `space_available` means number of chunks which can still be
/// Put.
#[no_mangle]
pub unsafe extern "C" fn get_account_info(session_handle: *const SessionHandle,
................................................................................

unsafe fn allocate_handle(session: Session) -> *mut SessionHandle {
    Box::into_raw(Box::new(Arc::new(Mutex::new(session))))
}

#[cfg(test)]
mod test {
    use super::*;
    use ffi::test_utils;
    use std::ptr;


    #[test]
    fn create_account_and_log_in() {
        let acc_locator = test_utils::generate_random_cstring(10);
        let acc_password = test_utils::generate_random_cstring(10);
        let invitation = test_utils::generate_random_cstring(10);

        {
            let mut session_handle: *mut SessionHandle = ptr::null_mut();

            unsafe {
                let session_handle_ptr = &mut session_handle;

                assert_eq!(create_account(acc_locator.as_ptr() as *const u8,
                                          10,
                                          acc_password.as_ptr() as *const u8,
                                          10,
                                          invitation.as_ptr() as *const u8,
                                          10,
                                          session_handle_ptr),
                           0);
            }

            assert!(!session_handle.is_null());
            unsafe { drop_session(session_handle) };