]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/helpers/activitypub.ts
Translated using Weblate (French (France))
[github/Chocobozzz/PeerTube.git] / server / helpers / activitypub.ts
index 5850fc19f36bd61c021c981dafdac715cc6b07dd..326785b680581fc4627a1b20a6bfd76151d86e7e 100644 (file)
+import * as Bluebird from 'bluebird'
+import validator from 'validator'
 import { ResultList } from '../../shared/models'
 import { Activity } from '../../shared/models/activitypub'
-import { ACTIVITY_PUB } from '../initializers'
-import { ActorModel } from '../models/activitypub/actor'
-import { signObject } from './peertube-crypto'
+import { ACTIVITY_PUB, REMOTE_SCHEME } from '../initializers/constants'
+import { signJsonLDObject } from './peertube-crypto'
+import { pageToStartAndCount } from './core-utils'
+import { URL } from 'url'
+import { MActor, MVideoAccountLight } from '../typings/models'
 
-function activityPubContextify <T> (data: T) {
-  return Object.assign(data,{
+export type ContextType = 'All' | 'View' | 'Announce'
+
+function activityPubContextify <T> (data: T, type: ContextType = 'All') {
+  const base = {
+    RsaSignature2017: 'https://w3id.org/security#RsaSignature2017'
+  }
+
+  if (type === 'All') {
+    Object.assign(base, {
+      pt: 'https://joinpeertube.org/ns#',
+      sc: 'http://schema.org#',
+      Hashtag: 'as:Hashtag',
+      uuid: 'sc:identifier',
+      category: 'sc:category',
+      licence: 'sc:license',
+      subtitleLanguage: 'sc:subtitleLanguage',
+      sensitive: 'as:sensitive',
+      language: 'sc:inLanguage',
+      expires: 'sc:expires',
+      CacheFile: 'pt:CacheFile',
+      Infohash: 'pt:Infohash',
+      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'
+      }
+    })
+  }
+
+  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'
-      }
+      base
     ]
   })
 }
 
-function activityPubCollection (results: any[]) {
-  return {
-    type: 'OrderedCollection',
-    totalItems: results.length,
-    orderedItems: results
+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'
+    }
   }
-}
 
-function activityPubCollectionPagination (url: string, page: any, result: ResultList<any>) {
-  let next: string
-  let prev: string
+  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)
 
   // There are more results
-  if (result.total > page * ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE) {
-    next = url + '?page=' + (page + 1)
+  if (result.total > page * size) {
+    next = baseUrl + '?page=' + (page + 1)
   }
 
   if (page > 1) {
-    prev = url + '?page=' + (page - 1)
+    prev = baseUrl + '?page=' + (page - 1)
   }
 
-  const orderedCollectionPagination = {
-    id: url + '?page=' + page,
+  return {
+    id: baseUrl + '?page=' + page,
     type: 'OrderedCollectionPage',
     prev,
     next,
-    partOf: url,
-    orderedItems: result.data
+    partOf: baseUrl,
+    orderedItems: result.data,
+    totalItems: result.total
   }
 
-  if (page === 1) {
-    return activityPubContextify({
-      id: url,
-      type: 'OrderedCollection',
-      totalItems: result.total,
-      first: orderedCollectionPagination
-    })
-  } else {
-    orderedCollectionPagination['totalItems'] = result.total
-  }
+}
+
+function buildSignedActivity (byActor: MActor, data: Object, contextType?: ContextType) {
+  const activity = activityPubContextify(data, contextType)
+
+  return signJsonLDObject(byActor, activity) as Promise<Activity>
+}
+
+function getAPId (activity: string | { id: string }) {
+  if (typeof activity === 'string') return activity
+
+  return activity.id
+}
+
+function checkUrlsSameHost (url1: string, url2: string) {
+  const idHost = new URL(url1).host
+  const actorHost = new URL(url2).host
 
-  return orderedCollectionPagination
+  return idHost && actorHost && idHost.toLowerCase() === actorHost.toLowerCase()
 }
 
-function buildSignedActivity (byActor: ActorModel, data: Object) {
-  const activity = activityPubContextify(data)
+function buildRemoteVideoBaseUrl (video: MVideoAccountLight, path: string) {
+  const host = video.VideoChannel.Account.Actor.Server.host
 
-  return signObject(byActor, activity) as Promise<Activity>
+  return REMOTE_SCHEME.HTTP + '://' + host + path
 }
 
 // ---------------------------------------------------------------------------
 
 export {
+  checkUrlsSameHost,
+  getAPId,
   activityPubContextify,
   activityPubCollectionPagination,
-  activityPubCollection,
-  buildSignedActivity
+  buildSignedActivity,
+  buildRemoteVideoBaseUrl
 }