Eventually-decentralized project hosting and management platform

[[ 🗃 ^WvWbo vervis ]] :: [📥 Inbox] [📤 Outbox] [🐤 Followers] [🤝 Collaborators] [🛠 Changes]

Clone

HTTPS: darcs clone https://vervis.peers.community/repos/WvWbo

SSH: darcs clone USERNAME@vervis.peers.community:WvWbo

Tags

TODO

src / Yesod /

ActivityPub.hs

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
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
{- This file is part of Vervis.
 -
 - Written in 2019, 2022, 2023 by fr33domlover <fr33domlover@riseup.net>.
 -
 - ♡ Copying is an act of love. Please copy, reuse and share.
 -
 - The author(s) have dedicated all copyright and related and neighboring
 - rights to this software to the public domain worldwide. This software is
 - distributed without any warranty.
 -
 - You should have received a copy of the CC0 Public Domain Dedication along
 - with this software. If not, see
 - <http://creativecommons.org/publicdomain/zero/1.0/>.
 -}

module Yesod.ActivityPub
    ( YesodActivityPub (..)

    --, prepareToSend
    , prepareToRetry
    , deliverActivity
    , deliverActivityExcept
    , deliverActivityThrow

    --, prepareToForward
    , forwardActivity
    , forwardActivityExcept
    , forwardActivityThrow

    , redirectToPrettyJSON

    , provideHtmlAndAP
    , provideHtmlAndAP'
    , provideHtmlAndAP''
    , provideHtmlFeedAndAP

    , hostIsLocalOld
    , verifyHostLocal
    )
where

import Control.Exception.Base
import Control.Monad
import Control.Monad.IO.Class
import Control.Monad.Logger.CallStack
import Control.Monad.Trans.Except
import Control.Monad.Trans.Writer
import Data.Aeson
import Data.Aeson.Encode.Pretty
import Data.ByteString (ByteString)
import Data.Foldable
import Data.Function
import Data.List
import Data.List.NonEmpty (NonEmpty)
import Data.Semigroup
import Data.Text (Text)
import Network.HTTP.Client
import Network.HTTP.Types.Header
import Yesod.AtomFeed
import Yesod.Core hiding (logError, logDebug)
import Yesod.Feed
import Yesod.RssFeed

import qualified Data.ByteString.Lazy as BL
import qualified Data.HashMap.Strict as M
import qualified Data.Text as T

import Network.HTTP.Signature

import qualified Network.HTTP.Signature as S

import Database.Persist.JSON
import Network.FedURI
import Web.ActivityPub
import Yesod.FedURI
import Yesod.MonadSite
import Yesod.RenderSource

import qualified Web.ActivityPub as AP

class (Yesod site, SiteFedURI site) => YesodActivityPub site where
    siteInstanceHost          :: site -> Authority (SiteFedURIMode site)
    sitePostSignedHeaders     :: site -> NonEmpty HeaderName
    {-
    siteGetHttpSign           :: (MonadSite m, SiteEnv m ~ site)
                              => m (KeyId, ByteString -> Signature)
    siteSigVerRequiredHeaders :: site -> [HeaderName]
    siteSigVerWantedHeaders   :: site -> [HeaderName]
    siteSigVerSeconds         :: site -> Int
    -}

prepareToSend
    :: (MonadSite m, SiteEnv m ~ site, SiteFedURI site, SiteFedURIMode site ~ u)
    => Route site
    -> (ByteString -> S.Signature)
    -> Bool
    -> Route site
    -> Route site
    -> AP.Action u
    -> m (Envelope u)
prepareToSend keyR sign holder actorR idR action = do
    encodeRouteLocal <- getEncodeRouteLocal
    encodeRouteHome <- getEncodeRouteHome
    let lruKey = LocalRefURI $ Left $ encodeRouteLocal keyR
        uActor = encodeRouteHome actorR
        luId = encodeRouteLocal idR
    return $ AP.sending lruKey sign holder uActor luId action

prepareToRetry
    :: (MonadSite m, SiteEnv m ~ site, SiteFedURI site, SiteFedURIMode site ~ u)
    => Route site
    -> (ByteString -> S.Signature)
    -> Maybe (Route site)
    -> BL.ByteString
    -> m (Envelope u)
prepareToRetry keyR sign mHolderR body = do
    encodeRouteLocal <- getEncodeRouteLocal
    encodeRouteHome <- getEncodeRouteHome
    let ruKey =
            let ObjURI h lu = encodeRouteHome keyR
            in  RefURI h $ LocalRefURI $ Left lu
        mluHolder = encodeRouteLocal <$> mHolderR
    return $ AP.retrying ruKey sign mluHolder body

deliverActivity
    :: ( MonadSite m, SiteEnv m ~ site, SiteFedURIMode site ~ u
       , YesodActivityPub site
       , HasHttpManager site
       )
    => Envelope u
    -> Maybe LocalURI
    -> ObjURI u
    -> m (Either APPostError (Response ()))
deliverActivity envelope mluFwd uInbox = do
    manager <- asksSite getHttpManager
    headers <- asksSite sitePostSignedHeaders
    AP.deliver manager headers envelope mluFwd uInbox

deliverActivityExcept
    :: ( MonadSite m, SiteEnv m ~ site, SiteFedURIMode site ~ u
       , YesodActivityPub site
       , HasHttpManager site
       )
    => Envelope u
    -> Maybe LocalURI
    -> ObjURI u
    -> ExceptT APPostError m (Response ())
deliverActivityExcept envelope mluFwd uInbox =
    ExceptT $ deliverActivity envelope mluFwd uInbox

deliverActivityThrow
    :: ( MonadSite m, SiteEnv m ~ site, SiteFedURIMode site ~ u
       , YesodActivityPub site
       , HasHttpManager site
       )
    => Envelope u
    -> Maybe LocalURI
    -> ObjURI u
    -> m (Response ())
deliverActivityThrow envelope mluFwd uInbox = do
    result <- deliverActivity envelope mluFwd uInbox
    case result of
        Left e -> liftIO $ throwIO e
        Right response -> return response

prepareToForward
    :: (MonadSite m, SiteEnv m ~ site, SiteFedURI site, SiteFedURIMode site ~ u)
    => Route site
    -> (ByteString -> S.Signature)
    -> Bool
    -> Route site
    -> BL.ByteString
    -> ByteString
    -> m (Errand u)
prepareToForward keyR sign holder fwderR body sig = do
    encodeRouteLocal <- getEncodeRouteLocal
    encodeRouteHome <- getEncodeRouteHome
    let lruKey = LocalRefURI $ Left $ encodeRouteLocal keyR
        uFwder = encodeRouteHome fwderR
    return $ AP.forwarding lruKey sign holder uFwder body sig

forwardActivity
    :: ( MonadSite m, SiteEnv m ~ site
       , SiteFedURI site, SiteFedURIMode site ~ u
       , HasHttpManager site
       , YesodActivityPub site
       )
    => Errand u
    -> ObjURI u
    -> m (Either APPostError (Response ()))
forwardActivity errand uInbox = do
    manager <- asksSite getHttpManager
    headers <- asksSite sitePostSignedHeaders
    AP.forward manager headers errand uInbox

forwardActivityExcept
    :: ( MonadSite m, SiteEnv m ~ site
       , SiteFedURI site, SiteFedURIMode site ~ u
       , HasHttpManager site
       , YesodActivityPub site
       )
    => Errand u
    -> ObjURI u
    -> ExceptT APPostError m (Response ())
forwardActivityExcept errand uInbox = ExceptT $ forwardActivity errand uInbox

forwardActivityThrow
    :: ( MonadSite m, SiteEnv m ~ site
       , SiteFedURI site, SiteFedURIMode site ~ u
       , HasHttpManager site
       , YesodActivityPub site
       )
    => Errand u
    -> ObjURI u
    -> m (Response ())
forwardActivityThrow errand uInbox = do
    result <- forwardActivity errand uInbox
    case result of
        Left e -> liftIO $ throwIO e
        Right response -> return response

{-
-- | An 'AP.Activity' ready for sending, attached to an actor key ready to sign
-- it
data Envelope u = Envelope
    { envelopeKey    :: LocalRefURI
    , envelopeSign   :: ByteString -> S.Signature
    , envelopeHolder :: Bool
    , envelopeActor  :: ObjURI u
    , envelopeId     :: LocalURI
    , envelopeAction :: Action u
    }
-}

{-
-- | An 'AP.Activity' ready for sending, attached to an actor key ready to sign
-- it
data Envelope site = Envelope
    { -- | Signing key's identifier URI
      envelopeKey       :: Route site
      -- | Signing function, producing a signature for a given input
    , envelopeSign      :: ByteString -> Signature
      -- | Whether the signing key is used for the whole instance, or a
      -- personal key used only by one actor
    , envelopeSharedKey :: Bool
      -- | The actor signing and sending the activity
    , envelopeActor     :: Route site
      -- | Activity's ID URI
    , envelopeId        :: Route site
      -- | Activity document, just needing its actor and id to be filled in
    , envelopeAction    :: AP.Action (SiteFedURIMode site)
    }
-}

{-
prepareActivity
    :: Route site
    -> (ByteString -> S.Signature)
    -> Bool
    -> Route site
    -> Route site
    -> AP.Action u
    -> m (Envelope u)
prepareActivity keyR sign holder actorR idR action = do
    encodeRouteLocal <- getEncodeRouteLocal
    encodeRouteHome <- getEncodeRouteHome
    let lruKey = LocalRefURI $ Left $ encodeRouteLocal keyR
        uActor = encodeRouteHome actorR
        luId = encodeRouteLocal idR
    return $ Envelope lruKey sign holder uActor luId action

    return $ AP.send manager headers lruKey sign holder uActor luId action

sendActivity
    :: Envelope u
    -> Maybe LocalURI
    -> ObjURI u
    -> m (Either AP.APPostError (Response ()))
sendActivity (Envelope lruKey sign holder uActor luId action)
-}

{-
prepareSendActivity
    :: ( MonadSite m
       , SiteEnv m ~ site
       , SiteFedURIMode site ~ u
       , HasHttpManager site
       , YesodActivityPub site
       )
    => Route site
    -> (ByteString -> S.Signature)
    -> Bool
    -> Route site
    -> Route site
    -> AP.Action u
    -> m (Maybe LocalURI -> ObjURI u -> m (Either AP.APPostError (Response ())))
prepareSendActivity keyR sign holder actorR idR action = do
    manager <- asksSite getHttpManager
    headers <- asksSite sitePostSignedHeaders
    encodeRouteLocal <- getEncodeRouteLocal
    encodeRouteHome <- getEncodeRouteHome
    let lruKey = LocalRefURI $ Left $ encodeRouteLocal keyR
        uActor = encodeRouteHome actorR
        luId = encodeRouteLocal idR
    return $ AP.send manager headers lruKey sign holder uActor luId action

resendActivity
    :: ( MonadSite m
       , SiteEnv m ~ site
       , SiteFedURIMode site ~ u
       , HasHttpManager site
       , YesodActivityPub site
       )
    => Route site
    -> (ByteString -> S.Signature)
    -> Maybe (Route site)
    -> BL.ByteString
    -> Maybe LocalURI
    -> ObjURI u
    -> m (Either AP.APPostError (Response ()))
resendActivity keyR sign mHolderR body mluFwd uInbox = do
    manager <- asksSite getHttpManager
    headers <- asksSite sitePostSignedHeaders
    encodeRouteLocal <- getEncodeRouteLocal
    encodeRouteHome <- getEncodeRouteHome
    let ruKey =
            let ObjURI h lu = encodeRouteHome keyR
            in  RefURI h $ LocalRefURI $ Left lu
        mluHolder = encodeRouteLocal <$> mHolderR
    AP.resend manager headers ruKey sign mluHolder body mluFwd uInbox

forwardActivity
    :: ( MonadSite m
       , SiteEnv m ~ site
       , SiteFedURIMode site ~ u
       , HasHttpManager site
       , YesodActivityPub site
       )
    -> Route site
    -> (ByteString -> S.Signature)
    -> Bool
    -> Route site
    -> BL.ByteString
    -> ByteString
    -> ObjURI u
    -> m (Either APPostError (Response ()))
forwardActivity keyR sign holder fwderR body sig uInbox = do
    manager <- asksSite getHttpManager
    headers <- asksSite sitePostSignedHeaders
    encodeRouteLocal <- getEncodeRouteLocal
    encodeRouteHome <- getEncodeRouteHome
    let lruKey = LocalRefURI $ Left $ encodeRouteLocal keyR
        uFwder = encodeRouteHome fwderR
    AP.forward lruKey sign holder uFwder body sig uInbox
-}

{-
data Stamp site = Stamp
    { stampActor :: Route site
    , stampKey   :: Route site
    , stampSign  :: ByteString -> Signature
    }

-- | An 'AP.Activity' ready for sending, attached to an actor key ready to sign
-- it
data Envelope site = Envelope
    { -- | Activity document, just needing its actor and id to be filled in
      envelopeDoc   :: AP.Action (SiteFedURIMode site)
      -- | Activity's ID URI
    , envelopeId    :: Route site
      -- | The actor signing and sending the activity
    , envelopeActor :: Route site
      -- | Signing key's identifier URI
    , envelopeKey   :: Route site
      -- | Signing function, producing a signature for a given input
    , envelopeSign  :: ByteString -> Signature
    }

deliverActivityBL
    :: ( MonadSite m
       , SiteEnv m ~ site
       , SiteFedURIMode site ~ u
       , HasHttpManager site
       , YesodActivityPub site
       )
    => ObjURI u
    -> Maybe (ObjURI u)
    -> Stamp
    -> BL.ByteString
    -> m (Either APPostError (Response ()))
deliverActivityBL inbox mfwd (Stamp actorR keyR sign) body = do
    manager <- asksSite getHttpManager
    headers <- asksSite sitePostSignedHeaders
    (sender, keyid) <- do
        renderUrl <- askUrlRender
        return (renderUrl actorR, KeyId $ renderUrl keyR)
    result <-
        httpPostAPBytes
            manager inbox headers keyid sign sender (Left <$> mfwd) body
    case result of
        Left err ->
            logError $ T.concat
                [ "deliverActivity to inbox <", renderObjURI inbox
                , "> error: ", T.pack $ displayException err
                ]
        Right resp ->
            logDebug $ T.concat
                [ "deliverActivity to inbox <", renderObjURI inbox
                , "> success: ", T.pack $ show $ responseStatus resp
                ]
    return result

deliverActivity
    :: ( MonadSite m
       , SiteEnv m ~ site
       , SiteFedURIMode site ~ u
       , HasHttpManager site
       , YesodActivityPub site
       )
    => ObjURI u
    -> Maybe (ObjURI u)
    -> Envelope site
    -> m (Either APPostError (Response ()))
deliverActivity inbox mfwd (Envelope action idR actorR keyR sign) = do
    encodeRouteLocal <- getEncodeRouteLocal
    hLocal <- asksSite siteInstanceHost
    let body =
            encode $ Doc hLocal $
                makeActivity
                    (encodeRouteLocal idR) (encodeRouteLocal actorR) action
    deliverActivityBL inbox mfwd (Stamp actorR keyR sign) body

data Errand site = Errand
    { errandDoc   :: BL.ByteString
    , errandProof :: ByteString
    , errandActor :: Route site
    , errandKey   :: Route site
    , errandSign  :: ByteString -> Signature
    }

forwardActivity
    :: ( MonadSite m
       , SiteEnv m ~ site
       , SiteFedURIMode site ~ u
       , HasHttpManager site
       , YesodActivityPub site
       )
    => ObjURI u
    -> Errand site
    -> m (Either APPostError (Response ()))
forwardActivity inbox (Errand doc sig actorR keyR sign) = do
    encodeRouteLocal <- getEncodeRouteLocal
    encodeRouteHome <- getEncodeRouteHome
    manager <- asksSite getHttpManager
    headers <- asksSite sitePostSignedHeaders
    let uActor = encodeRouteHome actorR
        lruKey = LocalRefURI $ Left $ encodeRouteLocal keyR
    result <- AP.forward manager headers uActor lruKey sign doc inbox sig
    case result of
        Left err ->
            logError $ T.concat
                [ "forwardActivity to inbox <", renderObjURI inbox
                , "> error: ", T.pack $ displayException err
                ]
        Right resp ->
            logDebug $ T.concat
                [ "forwardActivity to inbox <", renderObjURI inbox
                , "> success: ", T.pack $ show $ responseStatus resp
                ]
    return result
-}

redirectToPrettyJSON
    :: (MonadHandler m, HandlerSite m ~ site) => Route site -> m a
redirectToPrettyJSON route = redirect (route, [("prettyjson", "true")])

provideHtmlAndAP
    :: (YesodActivityPub site, SiteFedURIMode site ~ u, ActivityPub a)
    => a u -> WidgetFor site () -> HandlerFor site TypedContent
provideHtmlAndAP object widget = do
    host <- getsYesod siteInstanceHost
    provideHtmlAndAP' host object widget

provideHtmlAndAP_
    :: Yesod site
    => (a -> Writer (Endo [ProvidedRep (HandlerFor site)]) ())
    -> (a -> WidgetFor site ())
    -> (a -> WidgetFor site ())
    -> a
    -> WidgetFor site ()
    -> Maybe (Feed (Route site))
    -> HandlerFor site TypedContent
provideHtmlAndAP_ provide renderSky renderHl doc widget mfeed = selectRep $ do
    provide doc
    provideRep $ do
        mval <- lookupGetParam "prettyjson"
        defaultLayout $
            case mval of
                Just "true" -> do
                    mhl <- lookupGetParam "highlight"
                    let sky = case mhl of
                                Nothing -> True
                                Just "hl2" -> False
                                Just "sky" -> True
                                Just _ -> error "Invalid highlight style"
                    if sky
                        then renderSky doc
                        else renderHl doc
                    mroute <- getCurrentRoute
                    for_ mroute $ \ route -> do
                        params <- reqGetParams <$> getRequest
                        let params' =
                                delete' "prettyjson" $
                                    delete' "highlight" params
                        [whamlet|
                            <div>
                              <a href=@?{(route, params')}>
                                [See HTML]
                        |]
                _ -> do
                    widget
                    mroute <- getCurrentRoute
                    for_ mroute $ \ route -> do
                        params <- reqGetParams <$> getRequest
                        let pj = ("prettyjson", "true")
                            hl = ("highlight", "sky")
                            params' = pj : hl : params
                        [whamlet|
                            <div>
                              <a href=@?{(route, params')}>
                                [See JSON]
                        |]
    for_ mfeed $ \ feed -> do
        provideRep $ atomFeed feed
        provideRep $ rssFeed feed
    where
    delete' t = deleteBy ((==) `on` fst) (t, "")

provideHtmlAndAP'
    :: (YesodActivityPub site, SiteFedURIMode site ~ u, ActivityPub a)
    => Authority u -> a u -> WidgetFor site () -> HandlerFor site TypedContent
provideHtmlAndAP' host object widget =
    provideHtmlAndAP_
        (provideAP . pure)
        renderPrettyJSONSkylighting
        renderPrettyJSON
        (Doc host object)
        widget
        Nothing

provideHtmlAndAP''
    :: Yesod site
    => PersistJSON a -> WidgetFor site () -> HandlerFor site TypedContent
provideHtmlAndAP'' body widget =
    provideHtmlAndAP_
        (provideAP' . pure . persistJSONBytes)
        (renderPrettyJSONSkylighting' . encodePretty . persistJSONObject)
        (renderPrettyJSON' . encodePretty . persistJSONObject)
        body
        widget
        Nothing

provideHtmlFeedAndAP
    :: (YesodActivityPub site, SiteFedURIMode site ~ u, ActivityPub a)
    => a u
    -> Feed (Route site)
    -> WidgetFor site ()
    -> HandlerFor site TypedContent
provideHtmlFeedAndAP object feed widget = do
    host <- getsYesod siteInstanceHost
    provideHtmlAndAP_
        (provideAP . pure)
        renderPrettyJSONSkylighting
        renderPrettyJSON
        (Doc host object)
        widget
        (Just feed)

hostIsLocalOld
    :: (MonadSite m, SiteEnv m ~ site, YesodActivityPub site)
    => Authority (SiteFedURIMode site) -> m Bool
hostIsLocalOld h = asksSite $ (== h) . siteInstanceHost

verifyHostLocal
    :: (MonadSite m, SiteEnv m ~ site, YesodActivityPub site)
    => Authority (SiteFedURIMode site) -> Text -> ExceptT Text m ()
verifyHostLocal h t = do
    local <- hostIsLocalOld h
    unless local $ throwE t
[See repo JSON]