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 } from '../../shared/models/activitypub'
   5 import { ACTIVITY_PUB } from '../initializers'
   6 import { ActorModel } from '../models/activitypub/actor'
   7 import { signJsonLDObject } from './peertube-crypto'
   8 import { pageToStartAndCount } from './core-utils'
   9 import { parse } from 'url'
  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         views: 'sc:Number',
  28         state: 'sc:Number',
  29         size: 'sc:Number',
  30         fps: 'sc:Number',
  31         commentsEnabled: 'sc:Boolean',
  32         downloadEnabled: 'sc:Boolean',
  33         waitTranscoding: 'sc:Boolean',
  34         expires: 'sc:expires',
  35         support: 'sc:Text',
  36         CacheFile: 'pt:CacheFile',
  37         Infohash: 'pt:Infohash'
  38       },
  39       {
  40         likes: {
  41           '@id': 'as:likes',
  42           '@type': '@id'
  43         },
  44         dislikes: {
  45           '@id': 'as:dislikes',
  46           '@type': '@id'
  47         },
  48         shares: {
  49           '@id': 'as:shares',
  50           '@type': '@id'
  51         },
  52         comments: {
  53           '@id': 'as:comments',
  54           '@type': '@id'
  55         }
  56       }
  57     ]
  58   })
  59 }
  60
  61 type ActivityPubCollectionPaginationHandler = (start: number, count: number) => Bluebird<ResultList<any>> | Promise<ResultList<any>>
  62 async function activityPubCollectionPagination (baseUrl: string, handler: ActivityPubCollectionPaginationHandler, page?: any) {
  63   if (!page || !validator.isInt(page)) {
  64     // We just display the first page URL, we only need the total items
  65     const result = await handler(0, 1)
  66
  67     return {
  68       id: baseUrl,
  69       type: 'OrderedCollection',
  70       totalItems: result.total,
  71       first: baseUrl + '?page=1'
  72     }
  73   }
  74
  75   const { start, count } = pageToStartAndCount(page, ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE)
  76   const result = await handler(start, count)
  77
  78   let next: string | undefined
  79   let prev: string | undefined
  80
  81   // Assert page is a number
  82   page = parseInt(page, 10)
  83
  84   // There are more results
  85   if (result.total > page * ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE) {
  86     next = baseUrl + '?page=' + (page + 1)
  87   }
  88
  89   if (page > 1) {
  90     prev = baseUrl + '?page=' + (page - 1)
  91   }
  92
  93   return {
  94     id: baseUrl + '?page=' + page,
  95     type: 'OrderedCollectionPage',
  96     prev,
  97     next,
  98     partOf: baseUrl,
  99     orderedItems: result.data,
 100     totalItems: result.total
 101   }
 102
 103 }
 104
 105 function buildSignedActivity (byActor: ActorModel, data: Object) {
 106   const activity = activityPubContextify(data)
 107
 108   return signJsonLDObject(byActor, activity) as Promise<Activity>
 109 }
 110
 111 function getAPId (activity: string | { id: string }) {
 112   if (typeof activity === 'string') return activity
 113
 114   return activity.id
 115 }
 116
 117 function checkUrlsSameHost (url1: string, url2: string) {
 118   const idHost = parse(url1).host
 119   const actorHost = parse(url2).host
 120
 121   return idHost && actorHost && idHost.toLowerCase() === actorHost.toLowerCase()
 122 }
 123
 124 // ---------------------------------------------------------------------------
 125
 126 export {
 127   checkUrlsSameHost,
 128   getAPId,
 129   activityPubContextify,
 130   activityPubCollectionPagination,
 131   buildSignedActivity
 132 }