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
93
94
95
96
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
138
139
140
141
142
143
144
145
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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
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
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
use std::{any::Any, collections::HashMap, ffi::c_void, sync::Arc};

use ffi_sdk::{ffi_utils::char_p, BoxedDitto, DittoSdkTransportsError};
use safer_ffi::prelude::*;
use tracing::info;

use super::{
    sync_state::SyncState,
    transport_config::{LanConfig, TransportConfig},
};
use crate::{
    identity::SharedIdentity,
    utils::prelude::{DittoError, ErrorKind},
};

/// Handles for the various Transports
/// operating on the other side of the FFI interface
/// In other SDK, this struct is named *Sync*.
/// To avoid name conflict with ::Sync
/// *Transport* was prefixed.
pub struct TransportSync {
    ditto: Arc<BoxedDitto>,
    /// The effective state currently in use. Initially, it is the default empty TransportConfig.
    effective_state: SyncState,
    /// Parameters from which the effective state is computed.
    requested_state: SyncState,
    pub(crate) tcp_clients: HashMap<String, Box<dyn Any + Send + Sync>>,
    pub(crate) ws_clients: HashMap<String, Box<dyn Any + Send + Sync>>,
    mdns_transport_handle: Option<MdnsTransportHandleHolder>,
    ble_transport_handle: Option<BleTransportHandleHolder>,
}

struct MdnsTransportHandleHolder(*mut c_void);
unsafe impl Send for MdnsTransportHandleHolder {}
unsafe impl Sync for MdnsTransportHandleHolder {}

struct BleTransportHandleHolder(*mut c_void);
unsafe impl Send for BleTransportHandleHolder {}
unsafe impl Sync for BleTransportHandleHolder {}

// We make all transport-modifying methods here mutable since either the main
// executable thread or an automated process like the ValidityListener may try
// to change the transports at any time. This forces both to first acquire a
// WriteLock on the Transports struct before mutating the current state of the
// Transports or TransportConfig
impl TransportSync {
    pub(crate) fn from_config(
        config: TransportConfig,
        ditto: Arc<BoxedDitto>,
        identity: SharedIdentity,
    ) -> TransportSync {
        let web_valid = ffi_sdk::ditto_auth_client_is_web_valid(&ditto) != 0;
        let x509_valid = ffi_sdk::ditto_auth_client_is_x509_valid(&ditto) != 0;
        let requested_state = SyncState::new(config, identity.clone(), web_valid, x509_valid);
        let effective_state =
            SyncState::new(TransportConfig::new(), identity, web_valid, x509_valid);

        let mut error = DittoSdkTransportsError::None;
        unsafe { ffi_sdk::ditto_sdk_transports_init((&mut error).into()) };
        if error != DittoSdkTransportsError::None {
            tracing::error!(?error, "failed to perform transports init");
        }

        TransportSync {
            ditto,
            requested_state,
            effective_state,
            tcp_clients: HashMap::with_capacity(0), // no need to allocate until actually started
            ws_clients: HashMap::with_capacity(0),
            mdns_transport_handle: None,
            ble_transport_handle: None,
        }
    }

    pub(crate) fn start_sync(&mut self) {
        self.requested_state.set_sync(true);
        self.update()
    }

    pub(crate) fn stop_sync(&mut self) {
        self.requested_state.set_sync(false);
        self.update()
    }

    pub(crate) fn validity_updated(&mut self, web_valid: bool, x509_valid: bool) {
        self.requested_state
            .set_web_valid(web_valid)
            .set_x509_valid(x509_valid);
        self.update()
    }

    pub(crate) fn set_transport_config(&mut self, state: TransportConfig) {
        let config_cbor =
            serde_cbor::to_vec(&state).expect("TransportConfig can be serialized to CBOR");
        self.requested_state.set_config(state);
        self.update();
        ffi_sdk::ditto_small_peer_info_set_transport_config_data(
            &self.ditto,
            config_cbor.as_slice().into(),
        );
    }

    /// Update Transport layer using provided parameters.
    ///
    /// Afterwards, it also updates the effective state and applies changes.
    fn update(&mut self) {
        let future_state = self.requested_state.compute_effective_state();
        let old_state = self.effective_state.clone();
        self.apply_transport_state(&future_state, &old_state);
        self.apply_transport_global_state(&future_state, &old_state);
        self.effective_state = future_state;
    }

    fn apply_transport_state(&mut self, state: &SyncState, old_state: &SyncState) {
        // Diff the two states transport-by-transport
        // TCP and LAN are interrelated
        self.update_peer_to_peer_bluetooth_le(state, old_state);
        self.update_peer_to_peer_lan(state, old_state);
        self.update_listen_tcp(state, old_state);
        self.update_listen_http(state, old_state);
        self.update_connect_tcp_servers(state, old_state);
        self.update_connect_websocket_url(state, old_state);
        self.update_connect_retry_interval(state, old_state);
    }

    /// Return the user provided config.
    pub(crate) fn current_config(&self) -> &TransportConfig {
        self.requested_state.config()
    }

    /// Return the effective config.
    #[cfg(test)]
    pub(crate) fn effective_config(&self) -> &TransportConfig {
        self.effective_state.config()
    }

    fn apply_transport_global_state(&self, state: &SyncState, old_state: &SyncState) {
        let new_sync_group = state.config().global.sync_group;
        let old_sync_group = old_state.config().global.sync_group;

        if new_sync_group != old_sync_group {
            ffi_sdk::ditto_set_sync_group(&self.ditto, new_sync_group);
        }
    }

    /// Start a TCP Server which can listen for connections from other Peers
    /// Generally also requires a update to the relevant DNS zone file to be
    /// discoverable by other peers
    fn start_tcp_listen(&mut self, config: &crate::transport::TcpListenConfig) {
        let bind_ip = format!("{}:{}", config.interface_ip, config.port);
        let c_addr = char_p::new(bind_ip);
        // Convert to a public Error type
        let _result = ffi_sdk::ditto_start_tcp_server(&self.ditto, Some(c_addr.as_ref()));
    }

    fn stop_tcp_listen(&mut self) {
        ffi_sdk::ditto_stop_tcp_server(&self.ditto);
    }

    /// Starts an HTTP server that other devices will be able to connect to.
    /// * `bind_ip` - IP Address:Port on which to listen for connections
    /// * `enable_websocket` - If true, enable websocket transport
    /// * `static_path` - Optional root of web content directory
    /// * `tls_cert_path` - Optional x509 certificate for web server (also requires key)
    /// * `tls_key_path` - Optional TLS private key, required if cert is provided
    fn start_http_listen(
        &mut self,
        config: &crate::transport::HttpListenConfig,
    ) -> Result<(), DittoError> {
        let enable_ws = if config.websocket_sync {
            ffi_sdk::WebSocketMode::Enabled
        } else {
            ffi_sdk::WebSocketMode::Disabled
        };

        let bind_ip = format!("{}:{}", config.interface_ip, config.port);
        let c_addr = char_p::new(bind_ip);
        let c_static_path = config
            .static_content_path
            .as_ref()
            .map(|x| char_p::new(x.to_string_lossy().to_string()));
        let c_tls_cert_path = config
            .tls_certificate_path
            .as_ref()
            .map(|x| char_p::new(x.to_string_lossy().to_string()));
        let c_tls_key_path = config
            .tls_key_path
            .as_ref()
            .map(|x| char_p::new(x.to_string_lossy().to_string()));

        let status = {
            ffi_sdk::ditto_start_http_server(
                &self.ditto,
                Some(c_addr.as_ref()),
                c_static_path.as_ref().map(|x| x.as_ref()),
                enable_ws,
                c_tls_cert_path.as_ref().map(|x| x.as_ref()), // TLS cert path
                c_tls_key_path.as_ref().map(|x| x.as_ref()),  // TLS key path
            )
        };
        if status != 0 {
            Err(DittoError::from_ffi(ErrorKind::InvalidInput))
        } else {
            Ok(())
        }
    }

    fn stop_http_listen(&mut self) {
        ffi_sdk::ditto_stop_http_server(&self.ditto);
    }

    fn start_tcp_connect(&mut self, address: String) {
        let addr = char_p::new(address.clone());
        // this handle stores a tx entangled with an rx across the FFI boundary which
        // will drop if all tx elements drop
        let tcp_client_handle = ffi_sdk::ditto_add_static_tcp_client(&self.ditto, addr.as_ref());
        info!(?address, "static TCP client transport started");
        self.tcp_clients
            .insert(address, Box::new(tcp_client_handle));
    }

    fn stop_tcp_connect(&mut self, address: &str) {
        let _to_drop = self.tcp_clients.remove(address);
    }

    fn start_ws_connect(&mut self, url: String, routing_hint: u32) {
        let c_url = char_p::new(url.clone());
        let ws_client_handle =
            ffi_sdk::ditto_add_websocket_client(&self.ditto, c_url.as_ref(), routing_hint);
        info!(?url, "websocket client transport started");
        self.ws_clients.insert(url, Box::new(ws_client_handle));
    }

    fn stop_ws_connect(&mut self, url: &str) {
        let _to_drop = self.ws_clients.remove(url);
    }

    fn start_bluetooth(&mut self) {
        let mut error = DittoSdkTransportsError::None;
        let handle =
            unsafe { ffi_sdk::ditto_sdk_transports_ble_create(&self.ditto, (&mut error).into()) };

        if error == DittoSdkTransportsError::None {
            self.ble_transport_handle = Some(BleTransportHandleHolder(handle));
            tracing::info!("BLE transport started");
        } else {
            tracing::error!(?error, "failed to start BLE transport");
        }
    }

    fn stop_bluetooth(&mut self) {
        let Some(handle) = self.ble_transport_handle.take() else {
            return;
        };
        let mut error = DittoSdkTransportsError::None;
        unsafe { ffi_sdk::ditto_sdk_transports_ble_destroy(handle.0, (&mut error).into()) };
        if error != DittoSdkTransportsError::None {
            tracing::error!(?error, "failed to stop LAN transport");
        }
    }

    fn start_lan(&mut self, config: &LanConfig) {
        if config.mdns_enabled {
            tracing::info!("starting LAN transport");

            let mut error = DittoSdkTransportsError::None;

            let handle = unsafe {
                ffi_sdk::ditto_sdk_transports_lan_create(&self.ditto, (&mut error).into())
            };
            if error == DittoSdkTransportsError::None {
                self.mdns_transport_handle = Some(MdnsTransportHandleHolder(handle));
            } else {
                tracing::error!(?error, "failed to start LAN transport");
            }
        }

        #[allow(deprecated)] // Allowing deprecated for multicast_enabled
        if config.multicast_enabled {
            ffi_sdk::ditto_add_multicast_transport(&self.ditto);
        }
    }

    fn stop_lan(&mut self) {
        ffi_sdk::ditto_remove_multicast_transport(&self.ditto);

        let Some(handle) = self.mdns_transport_handle.take() else {
            return;
        };
        let mut error = DittoSdkTransportsError::None;
        unsafe { ffi_sdk::ditto_sdk_transports_lan_destroy(handle.0, (&mut error).into()) };
        if error != DittoSdkTransportsError::None {
            tracing::error!(?error, "failed to stop LAN transport");
        }
    }
}

/// This impl contains update for different transport protocols
impl TransportSync {
    fn update_peer_to_peer_lan(&mut self, state: &SyncState, old_state: &SyncState) {
        if state.config().listen.tcp != old_state.config().listen.tcp
            || state.config().peer_to_peer.lan != old_state.config().peer_to_peer.lan
        {
            self.stop_lan();
            if state.config().peer_to_peer.lan.enabled {
                self.start_lan(&state.config().peer_to_peer.lan);
            }
        }
    }

    fn update_listen_tcp(&mut self, state: &SyncState, old_state: &SyncState) {
        if state.config().listen.tcp != old_state.config().listen.tcp {
            self.stop_tcp_listen();
            if state.config().listen.tcp.enabled {
                self.start_tcp_listen(&state.config().listen.tcp);
            }
        }
    }

    fn update_listen_http(&mut self, state: &SyncState, old_state: &SyncState) {
        if state.config().listen.http != old_state.config().listen.http {
            self.stop_http_listen();
            if state.config().listen.http.enabled {
                let _ = self.start_http_listen(&state.config().listen.http);
            }
        }
    }

    fn update_connect_tcp_servers(&mut self, state: &SyncState, old_state: &SyncState) {
        let tcp_connects_to_stop = old_state
            .config()
            .connect
            .tcp_servers
            .difference(&state.config().connect.tcp_servers);
        for addr in tcp_connects_to_stop {
            self.stop_tcp_connect(addr);
        }

        let tcp_connects_to_start = state
            .config()
            .connect
            .tcp_servers
            .difference(&old_state.config().connect.tcp_servers);
        for addr in tcp_connects_to_start {
            self.start_tcp_connect(addr.clone());
        }
    }

    fn update_peer_to_peer_bluetooth_le(&mut self, state: &SyncState, old_state: &SyncState) {
        let new_ble_enabled = state.config().peer_to_peer.bluetooth_le.enabled;
        let old_ble_enabled = old_state.config().peer_to_peer.bluetooth_le.enabled;
        if old_ble_enabled && !new_ble_enabled {
            self.stop_bluetooth();
        }
        if new_ble_enabled && !old_ble_enabled {
            self.start_bluetooth();
        }
    }

    fn update_connect_websocket_url(&mut self, state: &SyncState, old_state: &SyncState) {
        let ws_connects_to_stop = old_state
            .config()
            .connect
            .websocket_urls
            .difference(&state.config().connect.websocket_urls);
        for url in ws_connects_to_stop {
            self.stop_ws_connect(url);
        }

        let ws_connects_to_start = state
            .config()
            .connect
            .websocket_urls
            .difference(&old_state.config().connect.websocket_urls);

        let routing_hint = state.config().global.routing_hint;
        for url in ws_connects_to_start {
            self.start_ws_connect(url.clone(), routing_hint);
        }
    }

    fn update_connect_retry_interval(&mut self, state: &SyncState, _old_state: &SyncState) {
        let retry_interval =
            u32::try_from(state.config().connect.retry_interval.as_millis()).unwrap_or(u32::MAX);

        ffi_sdk::ditto_set_connect_retry_interval(&self.ditto, retry_interval);
    }
}