PeerTube/server/helpers/activitypub.ts

222 lines
5.6 KiB
TypeScript
Raw Normal View History

import * as Bluebird from 'bluebird'
import { URL } from 'url'
2020-01-07 14:56:07 +01:00
import validator from 'validator'
import { ContextType } from '@shared/models/activitypub/context'
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'
import { ACTIVITY_PUB, REMOTE_SCHEME } from '../initializers/constants'
import { MActor, MVideoWithHost } from '../types/models'
import { pageToStartAndCount } from './core-utils'
import { signJsonLDObject } from './peertube-crypto'
2020-02-04 16:34:46 +01:00
function getContextData (type: ContextType) {
const context: any[] = [
'https://www.w3.org/ns/activitystreams',
'https://w3id.org/security/v1',
{
RsaSignature2017: 'https://w3id.org/security#RsaSignature2017'
}
]
2020-02-04 16:34:46 +01:00
if (type !== 'View' && type !== 'Announce') {
const additional = {
pt: 'https://joinpeertube.org/ns#',
2020-02-04 16:34:46 +01:00
sc: 'http://schema.org#'
}
if (type === 'CacheFile') {
Object.assign(additional, {
expires: 'sc:expires',
CacheFile: 'pt:CacheFile'
})
} else {
Object.assign(additional, {
Hashtag: 'as:Hashtag',
uuid: 'sc:identifier',
category: 'sc:category',
licence: 'sc:license',
subtitleLanguage: 'sc:subtitleLanguage',
sensitive: 'as:sensitive',
language: 'sc:inLanguage',
2020-12-03 14:10:54 +01:00
isLiveBroadcast: 'sc:isLiveBroadcast',
liveSaveReplay: {
'@type': 'sc:Boolean',
'@id': 'pt:liveSaveReplay'
},
permanentLive: {
'@type': 'sc:Boolean',
'@id': 'pt:permanentLive'
},
2020-02-04 16:34:46 +01:00
Infohash: 'pt:Infohash',
Playlist: 'pt:Playlist',
PlaylistElement: 'pt:PlaylistElement',
2020-02-04 16:34:46 +01:00
originallyPublishedAt: 'sc:datePublished',
views: {
'@type': 'sc:Number',
'@id': 'pt:views'
},
state: {
'@type': 'sc:Number',
'@id': 'pt:state'
},
size: {
'@type': 'sc:Number',
'@id': 'pt:size'
},
fps: {
'@type': 'sc:Number',
'@id': 'pt:fps'
},
startTimestamp: {
'@type': 'sc:Number',
'@id': 'pt:startTimestamp'
},
stopTimestamp: {
'@type': 'sc:Number',
'@id': 'pt:stopTimestamp'
},
position: {
'@type': 'sc:Number',
'@id': 'pt:position'
},
commentsEnabled: {
'@type': 'sc:Boolean',
'@id': 'pt:commentsEnabled'
},
downloadEnabled: {
'@type': 'sc:Boolean',
'@id': 'pt:downloadEnabled'
},
waitTranscoding: {
'@type': 'sc:Boolean',
'@id': 'pt:waitTranscoding'
},
support: {
'@type': 'sc:Text',
'@id': 'pt:support'
},
likes: {
'@id': 'as:likes',
'@type': '@id'
},
dislikes: {
'@id': 'as:dislikes',
'@type': '@id'
},
playlists: {
'@id': 'pt:playlists',
'@type': '@id'
},
shares: {
'@id': 'as:shares',
'@type': '@id'
},
comments: {
'@id': 'as:comments',
'@type': '@id'
}
})
}
context.push(additional)
}
2020-02-04 16:34:46 +01:00
return {
'@context': context
}
}
function activityPubContextify <T> (data: T, type: ContextType = 'All') {
return Object.assign({}, data, getContextData(type))
2017-11-09 17:51:58 +01:00
}
type ActivityPubCollectionPaginationHandler = (start: number, count: number) => Bluebird<ResultList<any>> | Promise<ResultList<any>>
2020-01-09 00:43:52 +01:00
async function activityPubCollectionPagination (
baseUrl: string,
handler: ActivityPubCollectionPaginationHandler,
page?: any,
size = ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE
) {
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,
2019-02-26 10:55:40 +01:00
type: 'OrderedCollectionPage',
totalItems: result.total,
2018-11-16 15:38:09 +01:00
first: baseUrl + '?page=1'
}
2017-11-23 16:55:13 +01:00
}
2020-01-09 00:43:52 +01:00
const { start, count } = pageToStartAndCount(page, size)
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
2020-01-09 00:43:52 +01:00
if (result.total > page * size) {
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
}
}
function buildSignedActivity (byActor: MActor, data: Object, contextType?: ContextType) {
const activity = activityPubContextify(data, contextType)
2017-11-17 11:35:10 +01:00
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) {
2020-01-31 16:56:52 +01:00
const idHost = new URL(url1).host
const actorHost = new URL(url2).host
2018-11-14 15:01:28 +01:00
return idHost && actorHost && idHost.toLowerCase() === actorHost.toLowerCase()
}
2021-02-18 10:15:11 +01:00
function buildRemoteVideoBaseUrl (video: MVideoWithHost, path: string, scheme?: string) {
if (!scheme) scheme = REMOTE_SCHEME.HTTP
const host = video.VideoChannel.Actor.Server.host
2021-02-18 10:15:11 +01:00
return scheme + '://' + host + path
}
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,
buildRemoteVideoBaseUrl
2017-11-09 17:51:58 +01:00
}