nostralink 0.2.4

Linked data library for nostr
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
//! Follow API

use super::custom_feeds::{CustomFeeds, PRED_FEED_FILTER_FOLLOW_PACK};
use super::manager::{RdfEventsStore, RdfStoreError};
use super::util::subl;
use crate::niri::{FromNamedNode, ToNamedNode};
use crate::oxistore::result_set::*;
use crate::querydb::nrq_get;
use nostr::PublicKey;
use oxigraph::model::vocab::rdf;
use oxigraph::model::*;
use std::sync::Arc;

pub trait FollowListManager {
    fn follow_list_node(
        &self,
        pubk: PublicKey,
        name: Option<&str>,
    ) -> Result<NamedNode, RdfStoreError>;

    fn follow_list_add(
        &self,
        flist_node: NamedNode,
        followed_pubk: PublicKey,
    ) -> Result<(), RdfStoreError>;
}

/// Follow packs
pub trait FollowPackManager {
    /// Follow/track a follow pack by its UUID
    fn fpack_follow(
        &self,
        follower_pubk: &PublicKey,
        uuid: &str,
    ) -> Result<(), RdfStoreError>;

    fn fpack_feed_follow(
        &self,
        follower_pubk: &PublicKey,
        uuid: &str,
        feed_node: NamedNodeRef,
    ) -> Result<(), RdfStoreError>;

    /// UnFollow a follow pack by its UUID
    fn fpack_unfollow(
        &self,
        follower_pubk: &PublicKey,
        uuid: &str,
        unfollow_members: bool,
    ) -> Result<bool, RdfStoreError>;

    /// Is this pubkey following this follow pack ?
    fn fpack_followed(
        &self,
        follower_pubk: &PublicKey,
        uuid: &str,
    ) -> Result<bool, RdfStoreError>;

    /// Return the list of public keys for the members of this follow pack
    fn fpack_members(
        &self,
        uuid: &str,
    ) -> Result<Vec<PublicKey>, RdfStoreError>;

    /// Synchronize follow pack for this follower
    /// Since follow packs can be edited (new members can be added), there needs to be
    /// a method to follow everyone in the latest edition of the follow pack
    fn fpack_sync(
        &self,
        follower_pubk: &PublicKey,
        uuid: &str,
    ) -> Result<(), RdfStoreError>;

    fn fpack_feed_sync(
        &self,
        follower_pubk: &PublicKey,
        uuid: &str,
        feed_node: NamedNodeRef,
    ) -> Result<(), RdfStoreError>;

    /// Return a list of follow packs UUIDs that a pubk follows
    fn fpack_following(
        &self,
        follower_pubk: &PublicKey,
    ) -> Result<Vec<String>, RdfStoreError>;
}

pub trait FolloweesManager {
    // Follow someone
    fn follow(
        &self,
        follower_pubk: PublicKey,
        followed_pubk: PublicKey,
    ) -> Result<(), RdfStoreError>;

    // Returns true is we're following this pubk, false otherwise
    fn following(
        &self,
        follower_pubk: PublicKey,
        followed_pubk: PublicKey,
    ) -> Result<bool, RdfStoreError>;

    // Unollow someone
    fn unfollow(
        &self,
        follower_pubk: PublicKey,
        followed_pubk: PublicKey,
    ) -> Result<(), RdfStoreError>;

    fn get_followees(
        &self,
        follower_pubk: PublicKey,
    ) -> Result<Arc<RdfResultSet>, RdfStoreError>;

    // Returns a list of followees for the given PublicKey, as a list of PublicKey
    fn followees_pubkeys(
        &self,
        follower_pubk: PublicKey,
    ) -> Result<Vec<PublicKey>, RdfStoreError>;
}

// "follows" predicate
pub const PRED_FOLLOWS: NamedNodeRef<'static> =
    NamedNodeRef::new_unchecked("https://w3id.org/nostr#follows");

// follow pack follows predicate
pub const PRED_FPACK_FOLLOWS: NamedNodeRef<'static> =
    NamedNodeRef::new_unchecked("https://w3id.org/nostr#follows_pack");

const PRED_FLIST_TYPE: NamedNodeRef<'static> =
    NamedNodeRef::new_unchecked("http://nostralink.org/FollowList");

impl FollowListManager for RdfEventsStore {
    fn follow_list_node(
        &self,
        pubk: PublicKey,
        name: Option<&str>,
    ) -> Result<NamedNode, RdfStoreError> {
        let fl_nn = pubk.named_node_with_f(name.unwrap_or("fl-default"))?;

        let _ = self.store.insert(QuadRef::new(
            &fl_nn,
            rdf::TYPE,
            PRED_FLIST_TYPE,
            &GraphName::DefaultGraph,
        ));
        Ok(fl_nn)
    }

    fn follow_list_add(
        &self,
        flist_node: NamedNode,
        followed_pubk: PublicKey,
    ) -> Result<(), RdfStoreError> {
        let followed_nn = followed_pubk.named_node()?;

        let _ = self.store.insert(QuadRef::new(
            &flist_node,
            PRED_FOLLOWS,
            &followed_nn,
            &GraphName::DefaultGraph,
        ));
        Ok(())
    }
}

impl FolloweesManager for RdfEventsStore {
    fn follow(
        &self,
        follower_pubk: PublicKey,
        followee_pubk: PublicKey,
    ) -> Result<(), RdfStoreError> {
        let follower_nn = follower_pubk.named_node()?;
        let followee_nn = followee_pubk.named_node()?;

        let _ = self.store.insert(QuadRef::new(
            &follower_nn,
            PRED_FOLLOWS,
            &followee_nn,
            &GraphName::DefaultGraph,
        ));
        Ok(())
    }

    fn following(
        &self,
        follower_pubk: PublicKey,
        followee_pubk: PublicKey,
    ) -> Result<bool, RdfStoreError> {
        let follower_nn = follower_pubk.named_node()?;
        let followee_nn = followee_pubk.named_node()?;

        let results = self
            .store
            .quads_for_pattern(
                Some((&follower_nn).into()),
                Some(PRED_FOLLOWS),
                Some((&followee_nn).into()),
                None,
            )
            .collect::<Result<Vec<_>, _>>()
            .map_err(|_| RdfStoreError::QueryError)?;

        Ok(!results.is_empty())
    }

    fn unfollow(
        &self,
        follower_pubk: PublicKey,
        followee_pubk: PublicKey,
    ) -> Result<(), RdfStoreError> {
        let follower_nn = follower_pubk.named_node()?;
        let followee_nn = followee_pubk.named_node()?;

        let _ = self.store.remove(QuadRef::new(
            &follower_nn,
            PRED_FOLLOWS,
            &followee_nn,
            &GraphName::DefaultGraph,
        ));
        Ok(())
    }

    fn get_followees(
        &self,
        follower_pubk: PublicKey,
    ) -> Result<Arc<RdfResultSet>, RdfStoreError> {
        let follower_nn = follower_pubk.named_node()?;

        let subs = [(Variable::new("follower").unwrap(), follower_nn.into())];

        self.run_query(&nrq_get("followees").unwrap(), subs, None)
            .map_err(|_| RdfStoreError::QueryError)
    }

    fn followees_pubkeys(
        &self,
        follower_pubk: PublicKey,
    ) -> Result<Vec<PublicKey>, RdfStoreError> {
        let follower_nn = follower_pubk.named_node()?;

        let results = self
            .store
            .quads_for_pattern(
                Some((&follower_nn).into()),
                Some(PRED_FOLLOWS),
                None,
                None,
            )
            .collect::<Result<Vec<_>, _>>()
            .map_err(|_| RdfStoreError::QueryError)?;

        Ok(results
            .iter()
            .filter_map(|quad| match &quad.object {
                Term::NamedNode(node) => node.from_named_node().ok(),
                _ => None,
            })
            .collect())
    }
}

impl FollowPackManager for RdfEventsStore {
    fn fpack_follow(
        &self,
        follower_pubk: &PublicKey,
        uuid: &str,
    ) -> Result<(), RdfStoreError> {
        let follower_nn = follower_pubk.named_node()?;

        let _ = self.store.insert(QuadRef::new(
            &follower_nn,
            PRED_FPACK_FOLLOWS,
            &Literal::from(uuid),
            &GraphName::DefaultGraph,
        ));

        self.fpack_sync(follower_pubk, uuid)
    }

    fn fpack_feed_follow(
        &self,
        follower_pubk: &PublicKey,
        uuid: &str,
        feed_node: NamedNodeRef,
    ) -> Result<(), RdfStoreError> {
        let follower_nn = follower_pubk.named_node()?;

        let _ = self.store.insert(QuadRef::new(
            &follower_nn,
            PRED_FPACK_FOLLOWS,
            &Literal::from(uuid),
            &GraphName::DefaultGraph,
        ));

        let _ = self.store.insert(QuadRef::new(
            feed_node,
            PRED_FEED_FILTER_FOLLOW_PACK,
            &Literal::from(uuid),
            &GraphName::DefaultGraph,
        ));

        self.fpack_feed_sync(follower_pubk, uuid, feed_node)
    }

    fn fpack_unfollow(
        &self,
        follower_pubk: &PublicKey,
        uuid: &str,
        unfollow_members: bool,
    ) -> Result<bool, RdfStoreError> {
        let follower_nn = follower_pubk.named_node()?;

        if unfollow_members {
            // Unfollow every member of the follow pack
            for pubk in self.fpack_members(uuid)? {
                self.unfollow(*follower_pubk, pubk)?;
            }
        }

        self.store
            .remove(QuadRef::new(
                &follower_nn,
                PRED_FPACK_FOLLOWS,
                &Literal::from(uuid),
                &GraphName::DefaultGraph,
            ))
            .map_err(|_| RdfStoreError::QueryError)
    }

    fn fpack_followed(
        &self,
        follower_pubk: &PublicKey,
        uuid: &str,
    ) -> Result<bool, RdfStoreError> {
        let follower_nn = follower_pubk.named_node()?;

        self.store
            .contains(QuadRef::new(
                &follower_nn,
                PRED_FPACK_FOLLOWS,
                &Literal::from(uuid),
                &GraphName::DefaultGraph,
            ))
            .map_err(|_| RdfStoreError::QueryError)
    }

    fn fpack_members(
        &self,
        uuid: &str,
    ) -> Result<Vec<PublicKey>, RdfStoreError> {
        let subs = [subl("uuid", Literal::from(uuid))?];

        Ok(self
            .run_query(&nrq_get("follow_pack_members").unwrap(), subs, None)
            .map_err(|_| RdfStoreError::QueryError)?
            .rows
            .iter()
            .filter_map(|row| {
                let m_pubk = row.get("member_pubk").unwrap();
                m_pubk.value.to_public_key().ok()
            })
            .collect())
    }

    fn fpack_sync(
        &self,
        follower_pubk: &PublicKey,
        uuid: &str,
    ) -> Result<(), RdfStoreError> {
        for pubk in self.fpack_members(uuid)? {
            self.follow(*follower_pubk, pubk)?;
        }

        Ok(())
    }

    fn fpack_feed_sync(
        &self,
        _follower_pubk: &PublicKey,
        uuid: &str,
        feed_node: NamedNodeRef,
    ) -> Result<(), RdfStoreError> {
        for pubk in self.fpack_members(uuid)? {
            self.feed_follow_pubkey(feed_node, &pubk)?;
        }

        Ok(())
    }

    fn fpack_following(
        &self,
        follower_pubk: &PublicKey,
    ) -> Result<Vec<String>, RdfStoreError> {
        let follower_nn = follower_pubk.named_node()?;

        let results = self
            .store
            .quads_for_pattern(
                Some((&follower_nn).into()),
                Some(PRED_FPACK_FOLLOWS),
                None,
                None,
            )
            .collect::<Result<Vec<_>, _>>()
            .map_err(|_| RdfStoreError::QueryError)?;

        Ok(results
            .iter()
            .filter_map(|quad| match &quad.object {
                Term::Literal(uuid) => Some(uuid.value().to_string()),
                _ => None,
            })
            .collect())
    }
}