syncweb-core 0.1.1-alpha.7

delay-tolerant web surfing
Documentation
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
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
use std::collections::{HashMap, HashSet};
use std::sync::{Arc, RwLock};

use iroh::PublicKey;
use iroh_docs::NamespaceId;

use crate::storage::node_db::NodeDatabase;
use crate::{Result, SyncwebError};

use super::network::{Network, NetworkId, NetworkOptions, NetworkTicket};
use super::network_log::{NetworkEventType, NetworkLogger};

/// Persistent manager for network membership and folder associations.
#[derive(Clone, Debug)]
pub struct NetworkManager {
    db: NodeDatabase,
    local_node: PublicKey,
    networks: HashMap<NetworkId, Network>,
    logger: Option<NetworkLogger>,
    member_keys: Arc<RwLock<HashSet<iroh::PublicKey>>>,
}

impl NetworkManager {
    /// Open the network database.
    ///
    /// # Errors
    ///
    /// Returns an error if existing state cannot be read.
    pub fn new(
        db: NodeDatabase,
        local_node: PublicKey,
        member_keys: Arc<RwLock<HashSet<iroh::PublicKey>>>,
    ) -> Result<Self> {
        let networks = db
            .list_networks()?
            .into_iter()
            .map(|network| (network.id, network))
            .collect();
        let mgr = Self {
            db,
            local_node,
            networks,
            logger: None,
            member_keys,
        };
        mgr.sync_member_keys();
        Ok(mgr)
    }

    /// Open the network database with a network logger.
    ///
    /// # Errors
    ///
    /// Returns an error if existing state cannot be read.
    pub fn with_logger(
        db: NodeDatabase,
        local_node: PublicKey,
        logger: NetworkLogger,
        member_keys: Arc<RwLock<HashSet<iroh::PublicKey>>>,
    ) -> Result<Self> {
        let mut mgr = Self::new(db, local_node, member_keys)?;
        mgr.logger = Some(logger);
        Ok(mgr)
    }

    /// Return a reference to the network logger, if set.
    #[must_use]
    pub const fn logger(&self) -> &Option<NetworkLogger> {
        &self.logger
    }

    /// Set the network logger after construction.
    pub fn set_logger(&mut self, logger: NetworkLogger) {
        self.logger = Some(logger);
    }

    /// Return a reference to the underlying database.
    #[must_use]
    pub const fn database(&self) -> &NodeDatabase {
        &self.db
    }

    /// Return the local node's public key.
    #[must_use]
    pub const fn local_node(&self) -> &iroh::PublicKey {
        &self.local_node
    }

    /// Create and persist a network owned by the local node.
    ///
    /// # Errors
    ///
    /// Returns an error for an empty/duplicate name or failed persistence.
    pub fn create(&mut self, name: &str, options: NetworkOptions) -> Result<NetworkId> {
        self.create_with_doc_ticket(name, options, None)
    }

    /// Create a network with an optional membership doc ticket.
    ///
    /// # Errors
    ///
    /// Returns an error for an empty/duplicate name or failed persistence.
    pub fn create_with_doc_ticket(
        &mut self,
        name: &str,
        options: NetworkOptions,
        doc_ticket: Option<String>,
    ) -> Result<NetworkId> {
        let normalized = name.trim();
        if normalized.is_empty() {
            return Err(SyncwebError::InvalidConfig("network name cannot be empty".to_owned()));
        }
        let id = NetworkId::from_name(normalized);
        if self.networks.contains_key(&id) {
            return Err(SyncwebError::InvalidConfig(format!(
                "network {normalized:?} already exists"
            )));
        }
        let mut network = Network::new(normalized, self.local_node, options);
        network.doc_ticket = doc_ticket;
        self.db.create_network(&network)?;
        self.networks.insert(id, network.clone());
        self.log_event(
            &id,
            NetworkEventType::MemberAdded,
            Some(&self.local_node),
            Some("created"),
        );
        if network.is_invite_only() {
            self.log_event(
                &id,
                NetworkEventType::TicketCreated,
                None,
                Some("invite-only network created"),
            );
        }
        Ok(id)
    }

    /// Join and persist the network represented by a ticket.
    ///
    /// # Errors
    ///
    /// Returns an error if the ticket is for another device or persistence fails.
    pub fn join(&mut self, ticket: NetworkTicket) -> Result<NetworkId> {
        if ticket.name.trim().is_empty() || NetworkId::from_name(ticket.name.trim()) != ticket.network_id {
            return Err(SyncwebError::InvalidTicket(
                "network ticket ID does not match its network name".to_owned(),
            ));
        }
        if ticket.invited_node.is_some_and(|invited| invited != self.local_node) {
            return Err(SyncwebError::InvalidTicket(
                "network ticket was issued for another device".to_owned(),
            ));
        }
        if self.networks.contains_key(&ticket.network_id) {
            return Err(SyncwebError::InvalidConfig(format!(
                "already joined network {}",
                ticket.network_id,
            )));
        }
        let mut members = ticket.members;
        members.insert(self.local_node);
        let network = Network {
            id: ticket.network_id,
            name: ticket.name,
            label: ticket.label,
            owner: ticket.owner,
            members,
            folders: ticket.folders,
            shared_secret: ticket.shared_secret,
            doc_ticket: ticket.doc_ticket,
        };
        let id = network.id;
        self.db.create_network(&network)?;
        self.networks.insert(id, network);
        self.log_event(
            &id,
            NetworkEventType::MemberAdded,
            Some(&self.local_node),
            Some("joined via ticket"),
        );
        self.sync_member_keys();
        self.log_event(&id, NetworkEventType::TicketAccepted, None, Some("network joined"));
        Ok(id)
    }

    /// Leave a network and remove its local state.
    ///
    /// # Errors
    ///
    /// Returns an error if the network does not exist or persistence fails.
    pub fn leave(&mut self, id: NetworkId) -> Result<()> {
        self.log_event(
            &id,
            NetworkEventType::MemberRemoved,
            Some(&self.local_node),
            Some("left network"),
        );
        self.networks
            .remove(&id)
            .ok_or_else(|| SyncwebError::FolderNotFound(format!("network {id}")))?;
        self.sync_member_keys();
        self.db.delete_network(id)
    }

    /// Generate a device-bound invitation and add the device as a member.
    ///
    /// # Errors
    ///
    /// Returns an error if the network does not exist, the local node is not
    /// its owner, or persistence fails.
    pub fn invite(&mut self, id: NetworkId, device: PublicKey) -> Result<NetworkTicket> {
        let network = self.network_mut_as_owner(id)?;
        network.members.insert(device);
        let ticket = NetworkTicket {
            network_id: network.id,
            name: network.name.clone(),
            label: network.label.clone(),
            owner: network.owner,
            invited_node: Some(device),
            members: network.members.clone(),
            folders: network.folders.clone(),
            shared_secret: network.shared_secret,
            doc_ticket: network.doc_ticket.clone(),
        };
        self.db.add_member(id, device)?;
        self.sync_member_keys();
        self.log_event(&id, NetworkEventType::MemberAdded, Some(&device), Some("invited"));
        self.log_event(
            &id,
            NetworkEventType::TicketCreated,
            None,
            Some("device-bound ticket generated"),
        );
        Ok(ticket)
    }

    /// Generate an invitation usable by any device.
    ///
    /// # Errors
    ///
    /// Returns an error if the network does not exist or the local node is not its owner.
    pub fn invite_any(&self, id: NetworkId) -> Result<NetworkTicket> {
        let network = self.network_as_owner(id)?;
        self.log_event(
            &id,
            NetworkEventType::TicketCreated,
            None,
            Some("open ticket generated"),
        );
        Ok(NetworkTicket {
            network_id: network.id,
            name: network.name.clone(),
            label: network.label.clone(),
            owner: network.owner,
            invited_node: None,
            members: network.members.clone(),
            folders: network.folders.clone(),
            shared_secret: network.shared_secret,
            doc_ticket: network.doc_ticket.clone(),
        })
    }

    /// Remove a member from a locally owned network.
    ///
    /// # Errors
    ///
    /// Returns an error if the network does not exist, authorization fails,
    /// the owner is targeted, or persistence fails.
    pub fn kick(&mut self, id: NetworkId, device: &PublicKey) -> Result<()> {
        let network = self.network_mut_as_owner(id)?;
        if network.owner == *device {
            return Err(SyncwebError::InvalidConfig(
                "the network owner cannot be kicked".to_owned(),
            ));
        }
        if !network.members.remove(device) {
            return Err(SyncwebError::InvalidConfig("device is not a network member".to_owned()));
        }
        self.db.remove_member(id, device)?;
        self.sync_member_keys();
        self.log_event(&id, NetworkEventType::MemberRemoved, Some(device), Some("kicked"));
        Ok(())
    }

    /// Set (or clear) the membership-doc ticket on a network.
    ///
    /// # Errors
    ///
    /// Returns an error if the network does not exist or persistence fails.
    pub fn set_doc_ticket(&mut self, id: NetworkId, doc_ticket: &Option<String>) -> Result<()> {
        let network = self
            .networks
            .get_mut(&id)
            .ok_or_else(|| SyncwebError::FolderNotFound(format!("network {id}")))?;
        network.doc_ticket.clone_from(doc_ticket);
        self.db.set_network_doc_ticket(id, doc_ticket)
    }

    /// Associate a folder with a network.
    ///
    /// # Errors
    ///
    /// Returns an error if the network does not exist or persistence fails.
    pub fn add_folder(&mut self, id: NetworkId, folder: NamespaceId) -> Result<()> {
        self.network_mut(id)?.folders.insert(folder);
        self.log_event(
            &id,
            NetworkEventType::FolderAdded,
            None,
            Some(&format!("folder {folder}")),
        );
        self.db.add_folder_to_network(id, folder)
    }

    /// Remove a folder association without changing the folder itself.
    ///
    /// # Errors
    ///
    /// Returns an error if the network does not exist or persistence fails.
    pub fn remove_folder(&mut self, id: NetworkId, folder: NamespaceId) -> Result<()> {
        self.network_mut(id)?.folders.remove(&folder);
        self.log_event(
            &id,
            NetworkEventType::FolderRemoved,
            None,
            Some(&format!("folder {folder}")),
        );
        self.db.remove_folder_from_network(id, folder)
    }

    #[must_use]
    pub fn list(&self) -> Vec<&Network> {
        let mut networks = self.networks.values().collect::<Vec<_>>();
        networks.sort_by(|left, right| left.name.cmp(&right.name));
        networks
    }

    #[must_use]
    pub fn get(&self, id: &NetworkId) -> Option<&Network> {
        self.networks.get(id)
    }

    #[must_use]
    pub fn get_by_name(&self, name: &str) -> Option<&Network> {
        self.networks.values().find(|network| network.name == name)
    }

    /// Return the network IDs (as strings) that contain a given folder.
    ///
    /// # Errors
    ///
    /// Returns an error if the database query fails.
    pub fn networks_for_folder(&self, namespace_id: &NamespaceId) -> Result<Vec<String>> {
        self.db.networks_for_folder(&namespace_id.to_string())
    }

    /// Return the first network ID that contains a given folder, if any.
    ///
    /// # Errors
    ///
    /// Returns an error if the database query fails.
    pub fn network_for_folder(&self, namespace_id: &NamespaceId) -> Result<Option<String>> {
        Ok(self
            .db
            .networks_for_folder(&namespace_id.to_string())?
            .into_iter()
            .next())
    }

    /// List all folder namespace IDs associated with a network.
    ///
    /// # Errors
    ///
    /// Returns an error if the database query fails.
    pub fn folders_for_network(&self, network_id: &NetworkId) -> Result<Vec<NamespaceId>> {
        let folders = self.db.folders_for_network(&network_id.to_string())?;
        folders
            .into_iter()
            .map(|f| {
                f.parse()
                    .map_err(|error| SyncwebError::operation("invalid namespace in database", error))
            })
            .collect()
    }

    /// List all members of a network.
    ///
    /// # Errors
    ///
    /// Returns an error if the database query fails.
    pub fn members_of_network(&self, network_id: &NetworkId) -> Result<Vec<iroh::PublicKey>> {
        let members = self.db.members_of_network(&network_id.to_string())?;
        members
            .into_iter()
            .map(|m| {
                m.parse()
                    .map_err(|error| SyncwebError::operation("invalid member key in database", error))
            })
            .collect()
    }

    /// Sync the `member_keys` set from all networks.
    fn sync_member_keys(&self) {
        let keys: HashSet<iroh::PublicKey> = self.networks.values().flat_map(|n| n.members.iter().copied()).collect();
        if let Ok(mut guard) = self.member_keys.write() {
            *guard = keys;
        }
    }

    fn log_event(
        &self,
        network_id: &NetworkId,
        event: NetworkEventType,
        peer: Option<&iroh::PublicKey>,
        details: Option<&str>,
    ) {
        if let Some(ref logger) = self.logger {
            let peer_str = peer.map(std::string::ToString::to_string);
            let _ = logger.record_event(&network_id.to_string(), event, peer_str.as_deref(), details);
        }
    }

    fn network_mut(&mut self, id: NetworkId) -> Result<&mut Network> {
        self.networks
            .get_mut(&id)
            .ok_or_else(|| SyncwebError::FolderNotFound(format!("network {id}")))
    }

    fn network_as_owner(&self, id: NetworkId) -> Result<&Network> {
        let network = self
            .networks
            .get(&id)
            .ok_or_else(|| SyncwebError::FolderNotFound(format!("network {id}")))?;
        if network.owner != self.local_node {
            return Err(SyncwebError::InvalidConfig(
                "only the network owner can manage invitations".to_owned(),
            ));
        }
        Ok(network)
    }

    fn network_mut_as_owner(&mut self, id: NetworkId) -> Result<&mut Network> {
        self.network_as_owner(id)?;
        self.network_mut(id)
    }
}