X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fhelpers%2Factivitypub.ts;h=fe721cbac1f01e351d157dd8a7d965c45ffd8c1d;hb=d17d743051c5716e1e08cd8870d718cfd6a57f0c;hp=a1493e5c13873bb0021f753c0aa2a7266c172b4e;hpb=571389d43b8fc8aaf27e77c06f19b320b08dbbc9;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/helpers/activitypub.ts b/server/helpers/activitypub.ts index a1493e5c1..fe721cbac 100644 --- a/server/helpers/activitypub.ts +++ b/server/helpers/activitypub.ts @@ -1,184 +1,220 @@ -import { join } from 'path' -import * as request from 'request' -import * as url from 'url' -import { ActivityIconObject } from '../../shared/index' -import { ActivityPubActor } from '../../shared/models/activitypub/activitypub-actor' -import { ResultList } from '../../shared/models/result-list.model' -import { database as db, REMOTE_SCHEME } from '../initializers' -import { CONFIG, STATIC_PATHS } from '../initializers/constants' -import { VideoInstance } from '../models/video/video-interface' -import { isRemoteAccountValid } from './custom-validators' -import { logger } from './logger' -import { doRequest, doRequestAndSaveToFile } from './requests' - -function generateThumbnailFromUrl (video: VideoInstance, icon: ActivityIconObject) { - const thumbnailName = video.getThumbnailName() - const thumbnailPath = join(CONFIG.STORAGE.THUMBNAILS_DIR, thumbnailName) - - const options = { - method: 'GET', - uri: icon.url - } - return doRequestAndSaveToFile(options, thumbnailPath) -} +import Bluebird from 'bluebird' +import { URL } from 'url' +import validator from 'validator' +import { ContextType } from '@shared/models/activitypub/context' +import { ResultList } from '../../shared/models' +import { ACTIVITY_PUB, REMOTE_SCHEME } from '../initializers/constants' +import { MActor, MVideoWithHost } from '../types/models' +import { pageToStartAndCount } from './core-utils' +import { signJsonLDObject } from './peertube-crypto' + +function getContextData (type: ContextType) { + const context: any[] = [ + 'https://www.w3.org/ns/activitystreams', + 'https://w3id.org/security/v1', + { + RsaSignature2017: 'https://w3id.org/security#RsaSignature2017' + } + ] -function getActivityPubUrl (type: 'video' | 'videoChannel' | 'account', id: string) { - if (type === 'video') return CONFIG.WEBSERVER.URL + '/videos/watch/' + id - else if (type === 'videoChannel') return CONFIG.WEBSERVER.URL + '/video-channels/' + id - else if (type === 'account') return CONFIG.WEBSERVER.URL + '/account/' + id + if (type !== 'View' && type !== 'Announce') { + const additional = { + pt: 'https://joinpeertube.org/ns#', + sc: 'http://schema.org#' + } - return '' -} + 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', + + isLiveBroadcast: 'sc:isLiveBroadcast', + liveSaveReplay: { + '@type': 'sc:Boolean', + '@id': 'pt:liveSaveReplay' + }, + permanentLive: { + '@type': 'sc:Boolean', + '@id': 'pt:permanentLive' + }, + + Infohash: 'pt:Infohash', + Playlist: 'pt:Playlist', + PlaylistElement: 'pt:PlaylistElement', + + 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' + } + }) + } -async function getOrCreateAccount (accountUrl: string) { - let account = await db.Account.loadByUrl(accountUrl) + context.push(additional) + } - // We don't have this account in our database, fetch it on remote - if (!account) { - const { account } = await fetchRemoteAccountAndCreatePod(accountUrl) + return { + '@context': context + } +} - if (!account) throw new Error('Cannot fetch remote account.') +function activityPubContextify (data: T, type: ContextType = 'All') { + return Object.assign({}, data, getContextData(type)) +} - // Save our new account in database - await account.save() +type ActivityPubCollectionPaginationHandler = (start: number, count: number) => Bluebird> | Promise> +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 { + id: baseUrl, + type: 'OrderedCollectionPage', + totalItems: result.total, + first: baseUrl + '?page=1' + } } - return account -} + const { start, count } = pageToStartAndCount(page, size) + const result = await handler(start, count) + + let next: string | undefined + let prev: string | undefined + + // Assert page is a number + page = parseInt(page, 10) -async function fetchRemoteAccountAndCreatePod (accountUrl: string) { - const options = { - uri: accountUrl, - method: 'GET' + // There are more results + if (result.total > page * size) { + next = baseUrl + '?page=' + (page + 1) } - let requestResult - try { - requestResult = await doRequest(options) - } catch (err) { - logger.warning('Cannot fetch remote account %s.', accountUrl, err) - return undefined + if (page > 1) { + prev = baseUrl + '?page=' + (page - 1) } - const accountJSON: ActivityPubActor = requestResult.body - if (isRemoteAccountValid(accountJSON) === false) return undefined - - const followersCount = await fetchAccountCount(accountJSON.followers) - const followingCount = await fetchAccountCount(accountJSON.following) - - const account = db.Account.build({ - uuid: accountJSON.uuid, - name: accountJSON.preferredUsername, - url: accountJSON.url, - publicKey: accountJSON.publicKey.publicKeyPem, - privateKey: null, - followersCount: followersCount, - followingCount: followingCount, - inboxUrl: accountJSON.inbox, - outboxUrl: accountJSON.outbox, - sharedInboxUrl: accountJSON.endpoints.sharedInbox, - followersUrl: accountJSON.followers, - followingUrl: accountJSON.following - }) - - const accountHost = url.parse(account.url).host - const podOptions = { - where: { - host: accountHost - }, - defaults: { - host: accountHost - } + return { + id: baseUrl + '?page=' + page, + type: 'OrderedCollectionPage', + prev, + next, + partOf: baseUrl, + orderedItems: result.data, + totalItems: result.total } - const pod = await db.Pod.findOrCreate(podOptions) - return { account, pod } } -function fetchRemoteVideoPreview (video: VideoInstance) { - // FIXME: use url - const host = video.VideoChannel.Account.Pod.host - const path = join(STATIC_PATHS.PREVIEWS, video.getPreviewName()) +function buildSignedActivity (byActor: MActor, data: T, contextType?: ContextType) { + const activity = activityPubContextify(data, contextType) - return request.get(REMOTE_SCHEME.HTTP + '://' + host + path) + return signJsonLDObject(byActor, activity) } -async function fetchRemoteVideoDescription (video: VideoInstance) { - const options = { - uri: video.url - } +function getAPId (object: string | { id: string }) { + if (typeof object === 'string') return object - const { body } = await doRequest(options) - return body.description ? body.description : '' + return object.id } -function activityPubContextify (data: T) { - return Object.assign(data,{ - '@context': [ - 'https://www.w3.org/ns/activitystreams', - 'https://w3id.org/security/v1', - { - 'Hashtag': 'as:Hashtag', - 'uuid': 'http://schema.org/identifier', - 'category': 'http://schema.org/category', - 'licence': 'http://schema.org/license', - 'nsfw': 'as:sensitive', - 'language': 'http://schema.org/inLanguage', - 'views': 'http://schema.org/Number', - 'size': 'http://schema.org/Number' - } - ] - }) +function checkUrlsSameHost (url1: string, url2: string) { + const idHost = new URL(url1).host + const actorHost = new URL(url2).host + + return idHost && actorHost && idHost.toLowerCase() === actorHost.toLowerCase() } -function activityPubCollectionPagination (url: string, page: number, result: ResultList) { - const baseUrl = url.split('?').shift +function buildRemoteVideoBaseUrl (video: MVideoWithHost, path: string, scheme?: string) { + if (!scheme) scheme = REMOTE_SCHEME.HTTP - const obj = { - id: baseUrl, - type: 'Collection', - totalItems: result.total, - first: { - id: baseUrl + '?page=' + page, - type: 'CollectionPage', - totalItems: result.total, - next: baseUrl + '?page=' + (page + 1), - partOf: baseUrl, - items: result.data - } - } + const host = video.VideoChannel.Actor.Server.host - return activityPubContextify(obj) + return scheme + '://' + host + path } // --------------------------------------------------------------------------- export { - fetchRemoteAccountAndCreatePod, + checkUrlsSameHost, + getAPId, activityPubContextify, activityPubCollectionPagination, - getActivityPubUrl, - generateThumbnailFromUrl, - getOrCreateAccount, - fetchRemoteVideoPreview, - fetchRemoteVideoDescription -} - -// --------------------------------------------------------------------------- - -async function fetchAccountCount (url: string) { - const options = { - uri: url, - method: 'GET' - } - - let requestResult - try { - requestResult = await doRequest(options) - } catch (err) { - logger.warning('Cannot fetch remote account count %s.', url, err) - return undefined - } - - return requestResult.totalItems ? requestResult.totalItems : 0 + buildSignedActivity, + buildRemoteVideoBaseUrl }