server/helpers/activitypub.ts

   1 import * as Bluebird from 'bluebird'
   2 import validator from 'validator'
   3 import { ResultList } from '../../shared/models'
   4 import { Activity } from '../../shared/models/activitypub'
   5 import { ACTIVITY_PUB } from '../initializers/constants'
   6 import { signJsonLDObject } from './peertube-crypto'
   7 import { pageToStartAndCount } from './core-utils'
   8 import { parse } from 'url'
   9 import { MActor } from '../typings/models'
  10
  11 function activityPubContextify <T> (data: T) {
  12   return Object.assign(data, {
  13     '@context': [
  14       'https://www.w3.org/ns/activitystreams',
  15       'https://w3id.org/security/v1',
  16       {
  17         RsaSignature2017: 'https://w3id.org/security#RsaSignature2017',
  18         pt: 'https://joinpeertube.org/ns#',
  19         sc: 'http://schema.org#',
  20         Hashtag: 'as:Hashtag',
  21         uuid: 'sc:identifier',
  22         category: 'sc:category',
  23         licence: 'sc:license',
  24         subtitleLanguage: 'sc:subtitleLanguage',
  25         sensitive: 'as:sensitive',
  26         language: 'sc:inLanguage',
  27         expires: 'sc:expires',
  28         CacheFile: 'pt:CacheFile',
  29         Infohash: 'pt:Infohash',
  30         originallyPublishedAt: 'sc:datePublished',
  31         views: {
  32           '@type': 'sc:Number',
  33           '@id': 'pt:views'
  34         },
  35         state: {
  36           '@type': 'sc:Number',
  37           '@id': 'pt:state'
  38         },
  39         size: {
  40           '@type': 'sc:Number',
  41           '@id': 'pt:size'
  42         },
  43         fps: {
  44           '@type': 'sc:Number',
  45           '@id': 'pt:fps'
  46         },
  47         startTimestamp: {
  48           '@type': 'sc:Number',
  49           '@id': 'pt:startTimestamp'
  50         },
  51         stopTimestamp: {
  52           '@type': 'sc:Number',
  53           '@id': 'pt:stopTimestamp'
  54         },
  55         position: {
  56           '@type': 'sc:Number',
  57           '@id': 'pt:position'
  58         },
  59         commentsEnabled: {
  60           '@type': 'sc:Boolean',
  61           '@id': 'pt:commentsEnabled'
  62         },
  63         downloadEnabled: {
  64           '@type': 'sc:Boolean',
  65           '@id': 'pt:downloadEnabled'
  66         },
  67         waitTranscoding: {
  68           '@type': 'sc:Boolean',
  69           '@id': 'pt:waitTranscoding'
  70         },
  71         support: {
  72           '@type': 'sc:Text',
  73           '@id': 'pt:support'
  74         }
  75       },
  76       {
  77         likes: {
  78           '@id': 'as:likes',
  79           '@type': '@id'
  80         },
  81         dislikes: {
  82           '@id': 'as:dislikes',
  83           '@type': '@id'
  84         },
  85         playlists: {
  86           '@id': 'pt:playlists',
  87           '@type': '@id'
  88         },
  89         shares: {
  90           '@id': 'as:shares',
  91           '@type': '@id'
  92         },
  93         comments: {
  94           '@id': 'as:comments',
  95           '@type': '@id'
  96         }
  97       }
  98     ]
  99   })
 100 }
 101
 102 type ActivityPubCollectionPaginationHandler = (start: number, count: number) => Bluebird<ResultList<any>> | Promise<ResultList<any>>
 103 async function activityPubCollectionPagination (baseUrl: string, handler: ActivityPubCollectionPaginationHandler, page?: any) {
 104   if (!page || !validator.isInt(page)) {
 105     // We just display the first page URL, we only need the total items
 106     const result = await handler(0, 1)
 107
 108     return {
 109       id: baseUrl,
 110       type: 'OrderedCollectionPage',
 111       totalItems: result.total,
 112       first: baseUrl + '?page=1'
 113     }
 114   }
 115
 116   const { start, count } = pageToStartAndCount(page, ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE)
 117   const result = await handler(start, count)
 118
 119   let next: string | undefined
 120   let prev: string | undefined
 121
 122   // Assert page is a number
 123   page = parseInt(page, 10)
 124
 125   // There are more results
 126   if (result.total > page * ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE) {
 127     next = baseUrl + '?page=' + (page + 1)
 128   }
 129
 130   if (page > 1) {
 131     prev = baseUrl + '?page=' + (page - 1)
 132   }
 133
 134   return {
 135     id: baseUrl + '?page=' + page,
 136     type: 'OrderedCollectionPage',
 137     prev,
 138     next,
 139     partOf: baseUrl,
 140     orderedItems: result.data,
 141     totalItems: result.total
 142   }
 143
 144 }
 145
 146 function buildSignedActivity (byActor: MActor, data: Object) {
 147   const activity = activityPubContextify(data)
 148
 149   return signJsonLDObject(byActor, activity) as Promise<Activity>
 150 }
 151
 152 function getAPId (activity: string | { id: string }) {
 153   if (typeof activity === 'string') return activity
 154
 155   return activity.id
 156 }
 157
 158 function checkUrlsSameHost (url1: string, url2: string) {
 159   const idHost = parse(url1).host
 160   const actorHost = parse(url2).host
 161
 162   return idHost && actorHost && idHost.toLowerCase() === actorHost.toLowerCase()
 163 }
 164
 165 // ---------------------------------------------------------------------------
 166
 167 export {
 168   checkUrlsSameHost,
 169   getAPId,
 170   activityPubContextify,
 171   activityPubCollectionPagination,
 172   buildSignedActivity
 173 }