1 import Bluebird from 'bluebird'
2 import { URL } from 'url'
3 import validator from 'validator'
4 import { ContextType } from '@shared/models/activitypub/context'
5 import { ResultList } from '../../shared/models'
6 import { ACTIVITY_PUB, REMOTE_SCHEME } from '../initializers/constants'
7 import { MActor, MVideoWithHost } from '../types/models'
8 import { pageToStartAndCount } from './core-utils'
9 import { signJsonLDObject } from './peertube-crypto'
11 function getContextData (type: ContextType) {
12 const context: any[] = [
13 'https://www.w3.org/ns/activitystreams',
14 'https://w3id.org/security/v1',
16 RsaSignature2017: 'https://w3id.org/security#RsaSignature2017'
20 if (type !== 'View' && type !== 'Announce') {
22 pt: 'https://joinpeertube.org/ns#',
23 sc: 'http://schema.org#'
26 if (type === 'CacheFile') {
27 Object.assign(additional, {
28 expires: 'sc:expires',
29 CacheFile: 'pt:CacheFile'
32 Object.assign(additional, {
33 Hashtag: 'as:Hashtag',
34 uuid: 'sc:identifier',
35 category: 'sc:category',
36 licence: 'sc:license',
37 subtitleLanguage: 'sc:subtitleLanguage',
38 sensitive: 'as:sensitive',
39 language: 'sc:inLanguage',
41 // TODO: remove in a few versions, introduced in 4.2
44 isLiveBroadcast: 'sc:isLiveBroadcast',
46 '@type': 'sc:Boolean',
47 '@id': 'pt:liveSaveReplay'
50 '@type': 'sc:Boolean',
51 '@id': 'pt:permanentLive'
55 '@id': 'pt:latencyMode'
58 Infohash: 'pt:Infohash',
59 Playlist: 'pt:Playlist',
60 PlaylistElement: 'pt:PlaylistElement',
62 originallyPublishedAt: 'sc:datePublished',
81 '@id': 'pt:startTimestamp'
85 '@id': 'pt:stopTimestamp'
92 '@type': 'sc:Boolean',
93 '@id': 'pt:commentsEnabled'
96 '@type': 'sc:Boolean',
97 '@id': 'pt:downloadEnabled'
100 '@type': 'sc:Boolean',
101 '@id': 'pt:waitTranscoding'
112 '@id': 'as:dislikes',
116 '@id': 'pt:playlists',
124 '@id': 'as:comments',
130 context.push(additional)
138 function activityPubContextify <T> (data: T, type: ContextType = 'All') {
139 return Object.assign({}, data, getContextData(type))
142 type ActivityPubCollectionPaginationHandler = (start: number, count: number) => Bluebird<ResultList<any>> | Promise<ResultList<any>>
143 async function activityPubCollectionPagination (
145 handler: ActivityPubCollectionPaginationHandler,
147 size = ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE
149 if (!page || !validator.isInt(page)) {
150 // We just display the first page URL, we only need the total items
151 const result = await handler(0, 1)
155 type: 'OrderedCollectionPage',
156 totalItems: result.total,
157 first: baseUrl + '?page=1'
161 const { start, count } = pageToStartAndCount(page, size)
162 const result = await handler(start, count)
164 let next: string | undefined
165 let prev: string | undefined
167 // Assert page is a number
168 page = parseInt(page, 10)
170 // There are more results
171 if (result.total > page * size) {
172 next = baseUrl + '?page=' + (page + 1)
176 prev = baseUrl + '?page=' + (page - 1)
180 id: baseUrl + '?page=' + page,
181 type: 'OrderedCollectionPage',
185 orderedItems: result.data,
186 totalItems: result.total
191 function buildSignedActivity <T> (byActor: MActor, data: T, contextType?: ContextType) {
192 const activity = activityPubContextify(data, contextType)
194 return signJsonLDObject(byActor, activity)
197 function getAPId (object: string | { id: string }) {
198 if (typeof object === 'string') return object
203 function checkUrlsSameHost (url1: string, url2: string) {
204 const idHost = new URL(url1).host
205 const actorHost = new URL(url2).host
207 return idHost && actorHost && idHost.toLowerCase() === actorHost.toLowerCase()
210 function buildRemoteVideoBaseUrl (video: MVideoWithHost, path: string, scheme?: string) {
211 if (!scheme) scheme = REMOTE_SCHEME.HTTP
213 const host = video.VideoChannel.Actor.Server.host
215 return scheme + '://' + host + path
218 // ---------------------------------------------------------------------------
223 activityPubContextify,
224 activityPubCollectionPagination,
226 buildRemoteVideoBaseUrl