Add ability for plugins to register ws routes

[github/Chocobozzz/PeerTube.git] / server / lib / plugins / plugin-helpers-builder.ts

diff --git a/server/lib/plugins/plugin-helpers-builder.ts b/server/lib/plugins/plugin-helpers-builder.ts
index cb1cd4d9a2c0097c29f5a31d52d98eb603345a65..7b1def6e30c9e171f8703f4751047374f8fbbfed 100644 (file)
--- a/server/lib/plugins/plugin-helpers-builder.ts
+++ b/server/lib/plugins/plugin-helpers-builder.ts
@@ -1,5 +1,7 @@
-import * as express from 'express'
+import express from 'express'
+import { Server } from 'http'
 import { join } from 'path'
+import { ffprobePromise } from '@server/helpers/ffmpeg/ffprobe-utils'
 import { buildLogger } from '@server/helpers/logger'
 import { CONFIG } from '@server/initializers/config'
 import { WEBSERVER } from '@server/initializers/constants'
@@ -9,17 +11,19 @@ import { AccountBlocklistModel } from '@server/models/account/account-blocklist'
 import { getServerActor } from '@server/models/application/application'
 import { ServerModel } from '@server/models/server/server'
 import { ServerBlocklistModel } from '@server/models/server/server-blocklist'
+import { UserModel } from '@server/models/user/user'
 import { VideoModel } from '@server/models/video/video'
 import { VideoBlacklistModel } from '@server/models/video/video-blacklist'
-import { MPlugin } from '@server/types/models'
+import { MPlugin, MVideo, UserNotificationModelForApi } from '@server/types/models'
 import { PeerTubeHelpers } from '@server/types/plugins'
-import { VideoBlacklistCreate } from '@shared/models'
+import { VideoBlacklistCreate, VideoStorage } from '@shared/models'
 import { addAccountInBlocklist, addServerInBlocklist, removeAccountFromBlocklist, removeServerFromBlocklist } from '../blocklist'
-import { getServerConfig } from '../config'
+import { PeerTubeSocket } from '../peertube-socket'
+import { ServerConfigManager } from '../server-config-manager'
 import { blacklistVideo, unblacklistVideo } from '../video-blacklist'
-import { UserModel } from '@server/models/user/user'
+import { VideoPathManager } from '../video-path-manager'
 
-function buildPluginHelpers (pluginModel: MPlugin, npmName: string): PeerTubeHelpers {
+function buildPluginHelpers (httpServer: Server, pluginModel: MPlugin, npmName: string): PeerTubeHelpers {
   const logger = buildPluginLogger(npmName)
 
   const database = buildDatabaseHelpers()
@@ -27,12 +31,14 @@ function buildPluginHelpers (pluginModel: MPlugin, npmName: string): PeerTubeHel
 
   const config = buildConfigHelpers()
 
-  const server = buildServerHelpers()
+  const server = buildServerHelpers(httpServer)
 
   const moderation = buildModerationHelpers()
 
   const plugin = buildPluginRelatedHelpers(pluginModel, npmName)
 
+  const socket = buildSocketHelpers()
+
   const user = buildUserHelpers()
 
   return {
@@ -43,6 +49,7 @@ function buildPluginHelpers (pluginModel: MPlugin, npmName: string): PeerTubeHel
     moderation,
     plugin,
     server,
+    socket,
     user
   }
 }
@@ -63,8 +70,10 @@ function buildDatabaseHelpers () {
   }
 }
 
-function buildServerHelpers () {
+function buildServerHelpers (httpServer: Server) {
   return {
+    getHTTPServer: () => httpServer,
+
     getServerActor: () => getServerActor()
   }
 }
@@ -81,10 +90,64 @@ function buildVideosHelpers () {
 
     removeVideo: (id: number) => {
       return sequelizeTypescript.transaction(async t => {
-        const video = await VideoModel.loadAndPopulateAccountAndServerAndTags(id, t)
+        const video = await VideoModel.loadFull(id, t)
 
         await video.destroy({ transaction: t })
       })
+    },
+
+    ffprobe: (path: string) => {
+      return ffprobePromise(path)
+    },
+
+    getFiles: async (id: number | string) => {
+      const video = await VideoModel.loadFull(id)
+      if (!video) return undefined
+
+      const webtorrentVideoFiles = (video.VideoFiles || []).map(f => ({
+        path: f.storage === VideoStorage.FILE_SYSTEM
+          ? VideoPathManager.Instance.getFSVideoFileOutputPath(video, f)
+          : null,
+        url: f.getFileUrl(video),
+
+        resolution: f.resolution,
+        size: f.size,
+        fps: f.fps
+      }))
+
+      const hls = video.getHLSPlaylist()
+
+      const hlsVideoFiles = hls
+        ? (video.getHLSPlaylist().VideoFiles || []).map(f => {
+          return {
+            path: f.storage === VideoStorage.FILE_SYSTEM
+              ? VideoPathManager.Instance.getFSVideoFileOutputPath(hls, f)
+              : null,
+            url: f.getFileUrl(video),
+            resolution: f.resolution,
+            size: f.size,
+            fps: f.fps
+          }
+        })
+        : []
+
+      const thumbnails = video.Thumbnails.map(t => ({
+        type: t.type,
+        url: t.getFileUrl(video),
+        path: t.getPath()
+      }))
+
+      return {
+        webtorrent: {
+          videoFiles: webtorrentVideoFiles
+        },
+
+        hls: {
+          videoFiles: hlsVideoFiles
+        },
+
+        thumbnails
+      }
     }
   }
 }
@@ -122,14 +185,14 @@ function buildModerationHelpers () {
     },
 
     blacklistVideo: async (options: { videoIdOrUUID: number | string, createOptions: VideoBlacklistCreate }) => {
-      const video = await VideoModel.loadAndPopulateAccountAndServerAndTags(options.videoIdOrUUID)
+      const video = await VideoModel.loadFull(options.videoIdOrUUID)
       if (!video) return
 
       await blacklistVideo(video, options.createOptions)
     },
 
     unblacklistVideo: async (options: { videoIdOrUUID: number | string }) => {
-      const video = await VideoModel.loadAndPopulateAccountAndServerAndTags(options.videoIdOrUUID)
+      const video = await VideoModel.loadFull(options.videoIdOrUUID)
       if (!video) return
 
       const videoBlacklist = await VideoBlacklistModel.loadByVideoId(video.id)
@@ -147,7 +210,7 @@ function buildConfigHelpers () {
     },
 
     getServerConfig () {
-      return getServerConfig()
+      return ServerConfigManager.Instance.getServerConfig()
     }
   }
 }
@@ -158,12 +221,29 @@ function buildPluginRelatedHelpers (plugin: MPlugin, npmName: string) {
 
     getBaseRouterRoute: () => `/plugins/${plugin.name}/${plugin.version}/router/`,
 
+    getBaseWebSocketRoute: () => `/plugins/${plugin.name}/${plugin.version}/ws/`,
+
     getDataDirectoryPath: () => join(CONFIG.STORAGE.PLUGINS_DIR, 'data', npmName)
   }
 }
 
+function buildSocketHelpers () {
+  return {
+    sendNotification: (userId: number, notification: UserNotificationModelForApi) => {
+      PeerTubeSocket.Instance.sendNotification(userId, notification)
+    },
+    sendVideoLiveNewState: (video: MVideo) => {
+      PeerTubeSocket.Instance.sendVideoLiveNewState(video)
+    }
+  }
+}
+
 function buildUserHelpers () {
   return {
+    loadById: (id: number) => {
+      return UserModel.loadByIdFull(id)
+    },
+
     getAuthUser: (res: express.Response) => {
       const user = res.locals.oauth?.token?.User
       if (!user) return undefined