server/helpers/activitypub.ts

   1 import * as Bluebird from 'bluebird'
   2 import * as validator from 'validator'
   3 import { ResultList } from '../../shared/models'
   4 import { Activity, ActivityPubActor } from '../../shared/models/activitypub'
   5 import { ACTIVITY_PUB } from '../initializers'
   6 import { ActorModel } from '../models/activitypub/actor'
   7 import { signObject } from './peertube-crypto'
   8 import { pageToStartAndCount } from './core-utils'
   9
  10 function activityPubContextify <T> (data: T) {
  11   return Object.assign(data, {
  12     '@context': [
  13       'https://www.w3.org/ns/activitystreams',
  14       'https://w3id.org/security/v1',
  15       {
  16         RsaSignature2017: 'https://w3id.org/security#RsaSignature2017',
  17         pt: 'https://joinpeertube.org/ns',
  18         schema: 'http://schema.org#',
  19         Hashtag: 'as:Hashtag',
  20         uuid: 'schema:identifier',
  21         category: 'schema:category',
  22         licence: 'schema:license',
  23         subtitleLanguage: 'schema:subtitleLanguage',
  24         sensitive: 'as:sensitive',
  25         language: 'schema:inLanguage',
  26         views: 'schema:Number',
  27         stats: 'schema:Number',
  28         size: 'schema:Number',
  29         fps: 'schema:Number',
  30         commentsEnabled: 'schema:Boolean',
  31         downloadingEnabled: 'schema:Boolean',
  32         waitTranscoding: 'schema:Boolean',
  33         expires: 'schema:expires',
  34         support: 'schema:Text',
  35         CacheFile: 'pt:CacheFile'
  36       },
  37       {
  38         likes: {
  39           '@id': 'as:likes',
  40           '@type': '@id'
  41         },
  42         dislikes: {
  43           '@id': 'as:dislikes',
  44           '@type': '@id'
  45         },
  46         shares: {
  47           '@id': 'as:shares',
  48           '@type': '@id'
  49         },
  50         comments: {
  51           '@id': 'as:comments',
  52           '@type': '@id'
  53         }
  54       }
  55     ]
  56   })
  57 }
  58
  59 type ActivityPubCollectionPaginationHandler = (start: number, count: number) => Bluebird<ResultList<any>> | Promise<ResultList<any>>
  60 async function activityPubCollectionPagination (url: string, handler: ActivityPubCollectionPaginationHandler, page?: any) {
  61   if (!page || !validator.isInt(page)) {
  62     // We just display the first page URL, we only need the total items
  63     const result = await handler(0, 1)
  64
  65     return {
  66       id: url,
  67       type: 'OrderedCollection',
  68       totalItems: result.total,
  69       first: url + '?page=1'
  70     }
  71   }
  72
  73   const { start, count } = pageToStartAndCount(page, ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE)
  74   const result = await handler(start, count)
  75
  76   let next: string | undefined
  77   let prev: string | undefined
  78
  79   // Assert page is a number
  80   page = parseInt(page, 10)
  81
  82   // There are more results
  83   if (result.total > page * ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE) {
  84     next = url + '?page=' + (page + 1)
  85   }
  86
  87   if (page > 1) {
  88     prev = url + '?page=' + (page - 1)
  89   }
  90
  91   return {
  92     id: url + '?page=' + page,
  93     type: 'OrderedCollectionPage',
  94     prev,
  95     next,
  96     partOf: url,
  97     orderedItems: result.data,
  98     totalItems: result.total
  99   }
 100
 101 }
 102
 103 function buildSignedActivity (byActor: ActorModel, data: Object) {
 104   const activity = activityPubContextify(data)
 105
 106   return signObject(byActor, activity) as Promise<Activity>
 107 }
 108
 109 function getActorUrl (activityActor: string | ActivityPubActor) {
 110   if (typeof activityActor === 'string') return activityActor
 111
 112   return activityActor.id
 113 }
 114
 115 // ---------------------------------------------------------------------------
 116
 117 export {
 118   getActorUrl,
 119   activityPubContextify,
 120   activityPubCollectionPagination,
 121   buildSignedActivity
 122 }