]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/helpers/activitypub.ts
Update server dependencies
[github/Chocobozzz/PeerTube.git] / server / helpers / activitypub.ts
index de20ba55d28989ce3e19a0b651c7a02cca3e7079..e0754b501b2ce39729997c298942c20a81f9fb89 100644 (file)
-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 { ACTIVITY_PUB_ACCEPT_HEADER, 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)
-}
-
-function getActivityPubUrl (type: 'video' | 'videoChannel' | 'account' | 'videoAbuse', 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
-  else if (type === 'videoAbuse') return CONFIG.WEBSERVER.URL + '/admin/video-abuses/' + id
+import * as 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'
+    }
+  ]
 
-  return ''
-}
+  if (type !== 'View' && type !== 'Announce') {
+    const additional = {
+      pt: 'https://joinpeertube.org/ns#',
+      sc: 'http://schema.org#'
+    }
 
-async function getOrCreateAccount (accountUrl: string) {
-  let account = await db.Account.loadByUrl(accountUrl)
+    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'
+        }
+      })
+    }
 
-  // We don't have this account in our database, fetch it on remote
-  if (!account) {
-    const res = await fetchRemoteAccountAndCreateServer(accountUrl)
-    if (res === undefined) throw new Error('Cannot fetch remote account.')
+    context.push(additional)
+  }
 
-    // Save our new account in database
-    const account = res.account
-    await account.save()
+  return {
+    '@context': context
   }
+}
 
-  return account
+function activityPubContextify <T> (data: T, type: ContextType = 'All') {
+  return Object.assign({}, data, getContextData(type))
 }
 
-async function fetchRemoteAccountAndCreateServer (accountUrl: string) {
-  const options = {
-    uri: accountUrl,
-    method: 'GET',
-    headers: {
-      'Accept': ACTIVITY_PUB_ACCEPT_HEADER
+type ActivityPubCollectionPaginationHandler = (start: number, count: number) => Bluebird<ResultList<any>> | Promise<ResultList<any>>
+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'
     }
   }
 
-  logger.info('Fetching remote account %s.', accountUrl)
+  const { start, count } = pageToStartAndCount(page, size)
+  const result = await handler(start, count)
 
-  let requestResult
-  try {
-    requestResult = await doRequest(options)
-  } catch (err) {
-    logger.warn('Cannot fetch remote account %s.', accountUrl, err)
-    return undefined
+  let next: string | undefined
+  let prev: string | undefined
+
+  // Assert page is a number
+  page = parseInt(page, 10)
+
+  // There are more results
+  if (result.total > page * size) {
+    next = baseUrl + '?page=' + (page + 1)
   }
 
-  const accountJSON: ActivityPubActor = JSON.parse(requestResult.body)
-  if (isRemoteAccountValid(accountJSON) === false) {
-    logger.debug('Remote account JSON is not valid.', { accountJSON })
-    return undefined
+  if (page > 1) {
+    prev = baseUrl + '?page=' + (page - 1)
   }
 
-  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 serverOptions = {
-    where: {
-      host: accountHost
-    },
-    defaults: {
-      host: accountHost
-    }
+  return {
+    id: baseUrl + '?page=' + page,
+    type: 'OrderedCollectionPage',
+    prev,
+    next,
+    partOf: baseUrl,
+    orderedItems: result.data,
+    totalItems: result.total
   }
-  const [ server ] = await db.Server.findOrCreate(serverOptions)
-  account.set('serverId', server.id)
 
-  return { account, server }
 }
 
-function fetchRemoteVideoPreview (video: VideoInstance) {
-  // FIXME: use url
-  const host = video.VideoChannel.Account.Server.host
-  const path = join(STATIC_PATHS.PREVIEWS, video.getPreviewName())
+function buildSignedActivity <T> (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 (activity: string | { id: string }) {
+  if (typeof activity === 'string') return activity
 
-  const { body } = await doRequest(options)
-  return body.description ? body.description : ''
+  return activity.id
 }
 
-function activityPubContextify <T> (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',
-        'VideoChannel': 'https://peertu.be/ns/VideoChannel'
-      }
-    ]
-  })
+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<any>) {
-  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 {
-  fetchRemoteAccountAndCreateServer,
+  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.warn('Cannot fetch remote account count %s.', url, err)
-    return undefined
-  }
-
-  return requestResult.totalItems ? requestResult.totalItems : 0
+  buildSignedActivity,
+  buildRemoteVideoBaseUrl
 }