PeerTube/server/helpers/activitypub.ts

134 lines
3.6 KiB
TypeScript
Raw Normal View History

import * as Bluebird from 'bluebird'
import * as validator from 'validator'
2017-12-12 17:53:50 +01:00
import { ResultList } from '../../shared/models'
2018-11-19 14:34:01 +01:00
import { Activity } from '../../shared/models/activitypub'
2017-12-12 17:53:50 +01:00
import { ACTIVITY_PUB } from '../initializers'
2017-12-14 17:38:41 +01:00
import { ActorModel } from '../models/activitypub/actor'
import { signJsonLDObject } from './peertube-crypto'
import { pageToStartAndCount } from './core-utils'
2018-11-14 15:01:28 +01:00
import { parse } from 'url'
2017-11-10 17:27:49 +01:00
function activityPubContextify <T> (data: T) {
return Object.assign(data, {
2017-11-09 17:51:58 +01:00
'@context': [
'https://www.w3.org/ns/activitystreams',
'https://w3id.org/security/v1',
{
RsaSignature2017: 'https://w3id.org/security#RsaSignature2017',
2019-01-29 08:37:25 +01:00
pt: 'https://joinpeertube.org/ns#',
sc: 'http://schema.org#',
Hashtag: 'as:Hashtag',
uuid: 'sc:identifier',
category: 'sc:category',
licence: 'sc:license',
subtitleLanguage: 'sc:subtitleLanguage',
sensitive: 'as:sensitive',
language: 'sc:inLanguage',
views: 'sc:Number',
state: 'sc:Number',
size: 'sc:Number',
fps: 'sc:Number',
commentsEnabled: 'sc:Boolean',
2019-02-11 11:52:34 +01:00
downloadEnabled: 'sc:Boolean',
waitTranscoding: 'sc:Boolean',
expires: 'sc:expires',
support: 'sc:Text',
2019-01-29 08:37:25 +01:00
CacheFile: 'pt:CacheFile',
2019-02-11 14:41:55 +01:00
Infohash: 'pt:Infohash',
originallyPublishedAt: 'sc:DateTime'
2018-01-29 11:05:52 +01:00
},
{
likes: {
'@id': 'as:likes',
'@type': '@id'
},
dislikes: {
'@id': 'as:dislikes',
'@type': '@id'
},
shares: {
'@id': 'as:shares',
'@type': '@id'
},
comments: {
'@id': 'as:comments',
'@type': '@id'
}
2017-11-09 17:51:58 +01:00
}
]
})
}
type ActivityPubCollectionPaginationHandler = (start: number, count: number) => Bluebird<ResultList<any>> | Promise<ResultList<any>>
2018-11-16 15:38:09 +01:00
async function activityPubCollectionPagination (baseUrl: string, handler: ActivityPubCollectionPaginationHandler, page?: any) {
if (!page || !validator.isInt(page)) {
// We just display the first page URL, we only need the total items
const result = await handler(0, 1)
return {
2018-11-16 15:38:09 +01:00
id: baseUrl,
type: 'OrderedCollection',
totalItems: result.total,
2018-11-16 15:38:09 +01:00
first: baseUrl + '?page=1'
}
2017-11-23 16:55:13 +01:00
}
const { start, count } = pageToStartAndCount(page, ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE)
const result = await handler(start, count)
let next: string | undefined
let prev: string | undefined
2017-11-21 18:23:10 +01:00
// Assert page is a number
page = parseInt(page, 10)
2017-11-21 18:23:10 +01:00
// There are more results
if (result.total > page * ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE) {
2018-11-16 15:38:09 +01:00
next = baseUrl + '?page=' + (page + 1)
2017-11-21 18:23:10 +01:00
}
if (page > 1) {
2018-11-16 15:38:09 +01:00
prev = baseUrl + '?page=' + (page - 1)
2017-11-21 18:23:10 +01:00
}
return {
2018-11-16 15:38:09 +01:00
id: baseUrl + '?page=' + page,
2017-11-21 18:23:10 +01:00
type: 'OrderedCollectionPage',
prev,
next,
2018-11-16 15:38:09 +01:00
partOf: baseUrl,
orderedItems: result.data,
totalItems: result.total
2017-11-09 17:51:58 +01:00
}
}
2017-12-14 17:38:41 +01:00
function buildSignedActivity (byActor: ActorModel, data: Object) {
2017-11-17 11:35:10 +01:00
const activity = activityPubContextify(data)
return signJsonLDObject(byActor, activity) as Promise<Activity>
2017-11-17 11:35:10 +01:00
}
function getAPId (activity: string | { id: string }) {
2018-11-19 14:34:01 +01:00
if (typeof activity === 'string') return activity
2018-11-19 14:34:01 +01:00
return activity.id
}
2018-11-14 15:01:28 +01:00
function checkUrlsSameHost (url1: string, url2: string) {
const idHost = parse(url1).host
const actorHost = parse(url2).host
return idHost && actorHost && idHost.toLowerCase() === actorHost.toLowerCase()
}
2017-11-09 17:51:58 +01:00
// ---------------------------------------------------------------------------
export {
2018-11-14 15:01:28 +01:00
checkUrlsSameHost,
getAPId,
2017-11-09 17:51:58 +01:00
activityPubContextify,
2017-11-10 14:34:45 +01:00
activityPubCollectionPagination,
buildSignedActivity
2017-11-09 17:51:58 +01:00
}