]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/helpers/activitypub.ts
Add upload/import/go live video attributes hooks
[github/Chocobozzz/PeerTube.git] / server / helpers / activitypub.ts
index ecb509b66c81dd9edea35d7466717493ff77b422..fe721cbac1f01e351d157dd8a7d965c45ffd8c1d 100644 (file)
-import * as url from 'url'
-
-import { database as db } from '../initializers'
-import { logger } from './logger'
-import { doRequest } from './requests'
-import { isRemoteAccountValid } from './custom-validators'
-import { ActivityPubActor } from '../../shared/models/activitypub/activitypub-actor'
-import { ResultList } from '../../shared/models/result-list.model'
-
-async function fetchRemoteAccountAndCreatePod (accountUrl: string) {
-  const options = {
-    uri: accountUrl,
-    method: 'GET'
-  }
+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'
+    }
+  ]
 
-  let requestResult
-  try {
-    requestResult = await doRequest(options)
-  } catch (err) {
-    logger.warning('Cannot fetch remote account %s.', accountUrl, err)
-    return undefined
-  }
+  if (type !== 'View' && type !== 'Announce') {
+    const additional = {
+      pt: 'https://joinpeertube.org/ns#',
+      sc: 'http://schema.org#'
+    }
 
-  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
+    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'
+        }
+      })
     }
+
+    context.push(additional)
   }
-  const pod = await db.Pod.findOrCreate(podOptions)
 
-  return { account, pod }
+  return {
+    '@context': context
+  }
 }
 
-function activityPubContextify (data: object) {
-  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 activityPubContextify <T> (data: T, type: ContextType = 'All') {
+  return Object.assign({}, data, getContextData(type))
 }
 
-function activityPubCollectionPagination (url: string, page: number, result: ResultList<any>) {
-  const baseUrl = url.split('?').shift
-
-  const obj = {
-    id: baseUrl,
-    type: 'Collection',
-    totalItems: result.total,
-    first: {
-      id: baseUrl + '?page=' + page,
-      type: 'CollectionPage',
+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,
-      next: baseUrl + '?page=' + (page + 1),
-      partOf: baseUrl,
-      items: result.data
+      first: baseUrl + '?page=1'
     }
   }
 
-  return activityPubContextify(obj)
-}
+  const { start, count } = pageToStartAndCount(page, size)
+  const result = await handler(start, count)
 
-// ---------------------------------------------------------------------------
+  let next: string | undefined
+  let prev: string | undefined
 
-export {
-  fetchRemoteAccountAndCreatePod,
-  activityPubContextify,
-  activityPubCollectionPagination
-}
+  // Assert page is a number
+  page = parseInt(page, 10)
 
-// ---------------------------------------------------------------------------
+  // There are more results
+  if (result.total > page * size) {
+    next = baseUrl + '?page=' + (page + 1)
+  }
 
-async function fetchAccountCount (url: string) {
-  const options = {
-    uri: url,
-    method: 'GET'
+  if (page > 1) {
+    prev = baseUrl + '?page=' + (page - 1)
   }
 
-  let requestResult
-  try {
-    requestResult = await doRequest(options)
-  } catch (err) {
-    logger.warning('Cannot fetch remote account count %s.', url, err)
-    return undefined
+  return {
+    id: baseUrl + '?page=' + page,
+    type: 'OrderedCollectionPage',
+    prev,
+    next,
+    partOf: baseUrl,
+    orderedItems: result.data,
+    totalItems: result.total
   }
 
-  return requestResult.totalItems ? requestResult.totalItems : 0
+}
+
+function buildSignedActivity <T> (byActor: MActor, data: T, contextType?: ContextType) {
+  const activity = activityPubContextify(data, contextType)
+
+  return signJsonLDObject(byActor, activity)
+}
+
+function getAPId (object: string | { id: string }) {
+  if (typeof object === 'string') return object
+
+  return object.id
+}
+
+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 buildRemoteVideoBaseUrl (video: MVideoWithHost, path: string, scheme?: string) {
+  if (!scheme) scheme = REMOTE_SCHEME.HTTP
+
+  const host = video.VideoChannel.Actor.Server.host
+
+  return scheme + '://' + host + path
+}
+
+// ---------------------------------------------------------------------------
+
+export {
+  checkUrlsSameHost,
+  getAPId,
+  activityPubContextify,
+  activityPubCollectionPagination,
+  buildSignedActivity,
+  buildRemoteVideoBaseUrl
 }