PeerTube/server/core/lib/plugins/plugin-helpers-builder.ts

278 lines
8.2 KiB
TypeScript
Raw Normal View History

2021-08-27 14:32:44 +02:00
import express from 'express'
import { Server } from 'http'
import { join } from 'path'
import { buildLogger } from '@server/helpers/logger.js'
import { CONFIG } from '@server/initializers/config.js'
import { WEBSERVER } from '@server/initializers/constants.js'
import { sequelizeTypescript } from '@server/initializers/database.js'
import { AccountModel } from '@server/models/account/account.js'
import { AccountBlocklistModel } from '@server/models/account/account-blocklist.js'
import { getServerActor } from '@server/models/application/application.js'
import { ServerModel } from '@server/models/server/server.js'
import { ServerBlocklistModel } from '@server/models/server/server-blocklist.js'
import { UserModel } from '@server/models/user/user.js'
import { VideoModel } from '@server/models/video/video.js'
import { VideoBlacklistModel } from '@server/models/video/video-blacklist.js'
import { MPlugin, MVideo, UserNotificationModelForApi } from '@server/types/models/index.js'
import { PeerTubeHelpers } from '@server/types/plugins/index.js'
import { ffprobePromise } from '@peertube/peertube-ffmpeg'
2024-02-12 10:47:52 +01:00
import { VideoBlacklistCreate, FileStorage } from '@peertube/peertube-models'
import { addAccountInBlocklist, addServerInBlocklist, removeAccountFromBlocklist, removeServerFromBlocklist } from '../blocklist.js'
import { PeerTubeSocket } from '../peertube-socket.js'
import { ServerConfigManager } from '../server-config-manager.js'
import { blacklistVideo, unblacklistVideo } from '../video-blacklist.js'
import { VideoPathManager } from '../video-path-manager.js'
2020-04-09 09:57:32 +02:00
function buildPluginHelpers (httpServer: Server, pluginModel: MPlugin, npmName: string): PeerTubeHelpers {
2020-04-09 11:00:30 +02:00
const logger = buildPluginLogger(npmName)
const database = buildDatabaseHelpers()
const videos = buildVideosHelpers()
2020-04-09 09:57:32 +02:00
2020-04-30 08:46:40 +02:00
const config = buildConfigHelpers()
const server = buildServerHelpers(httpServer)
2020-05-07 14:58:24 +02:00
const moderation = buildModerationHelpers()
const plugin = buildPluginRelatedHelpers(pluginModel, npmName)
const socket = buildSocketHelpers()
const user = buildUserHelpers()
2021-04-09 14:51:28 +02:00
2020-04-09 09:57:32 +02:00
return {
2020-04-09 11:00:30 +02:00
logger,
database,
2020-04-30 08:46:40 +02:00
videos,
2020-05-07 14:58:24 +02:00
config,
moderation,
2021-04-09 14:51:28 +02:00
plugin,
server,
socket,
user
2020-04-09 09:57:32 +02:00
}
}
export {
buildPluginHelpers
}
// ---------------------------------------------------------------------------
2020-04-09 11:00:30 +02:00
function buildPluginLogger (npmName: string) {
2020-04-09 09:57:32 +02:00
return buildLogger(npmName)
}
2020-04-09 11:00:30 +02:00
function buildDatabaseHelpers () {
return {
query: sequelizeTypescript.query.bind(sequelizeTypescript)
}
}
function buildServerHelpers (httpServer: Server) {
2020-05-07 14:58:24 +02:00
return {
getHTTPServer: () => httpServer,
2020-05-07 14:58:24 +02:00
getServerActor: () => getServerActor()
}
}
function buildVideosHelpers () {
return {
2020-05-07 14:58:24 +02:00
loadByUrl: (url: string) => {
return VideoModel.loadByUrl(url)
},
2021-02-11 10:23:52 +01:00
loadByIdOrUUID: (id: number | string) => {
return VideoModel.load(id)
},
loadByIdOrUUIDWithFiles: (id: number | string) => {
return VideoModel.loadWithFiles(id)
},
removeVideo: (id: number) => {
return sequelizeTypescript.transaction(async t => {
2022-06-28 14:57:51 +02:00
const video = await VideoModel.loadFull(id, t)
await video.destroy({ transaction: t })
})
2021-12-16 16:49:43 +01:00
},
2021-12-16 17:00:46 +01:00
ffprobe: (path: string) => {
return ffprobePromise(path)
},
2021-12-16 16:49:43 +01:00
getFiles: async (id: number | string) => {
2022-06-28 14:57:51 +02:00
const video = await VideoModel.loadFull(id)
2021-12-16 16:49:43 +01:00
if (!video) return undefined
const webVideoFiles = (video.VideoFiles || []).map(f => ({
2024-02-12 10:47:52 +01:00
path: f.storage === FileStorage.FILE_SYSTEM
2021-12-16 16:49:43 +01:00
? 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 {
2024-02-12 10:47:52 +01:00
path: f.storage === FileStorage.FILE_SYSTEM
2021-12-16 16:49:43 +01:00
? 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,
Add Podcast RSS feeds (#5487) * Initial test implementation of Podcast RSS This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option. I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort. * Update to pfeed-podcast 1.2.2 * Initial test implementation of Podcast RSS This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option. I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort. * Update to pfeed-podcast 1.2.2 * Initial test implementation of Podcast RSS This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option. I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort. * Update to pfeed-podcast 1.2.2 * Add correct feed image to RSS channel * Prefer HLS videos for podcast RSS Remove video/stream titles, add optional height attribute to podcast RSS * Prefix podcast RSS images with root server URL * Add optional video query support to include captions * Add transcripts & person images to podcast RSS feed * Prefer webseed/webtorrent files over HLS fragmented mp4s * Experimentally adding podcast fields to basic config page * Add validation for new basic config fields * Don't include "content" in podcast feed, use full description for "description" * Initial test implementation of Podcast RSS This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option. I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort. * Update to pfeed-podcast 1.2.2 * Add correct feed image to RSS channel * Prefer HLS videos for podcast RSS Remove video/stream titles, add optional height attribute to podcast RSS * Prefix podcast RSS images with root server URL * Add optional video query support to include captions * Add transcripts & person images to podcast RSS feed * Prefer webseed/webtorrent files over HLS fragmented mp4s * Experimentally adding podcast fields to basic config page * Add validation for new basic config fields * Don't include "content" in podcast feed, use full description for "description" * Add medium/socialInteract to podcast RSS feeds. Use HTML for description * Change base production image to bullseye, install prosody in image * Add liveItem and trackers to Podcast RSS feeds Remove height from alternateEnclosure, replaced with title. * Clear Podcast RSS feed cache when live streams start/end * Upgrade to Node 16 * Refactor clearCacheRoute to use ApiCache * Remove unnecessary type hint * Update dockerfile to node 16, install python-is-python2 * Use new file paths for captions/playlists * Fix legacy videos in RSS after migration to object storage * Improve method of identifying non-fragmented mp4s in podcast RSS feeds * Don't include fragmented MP4s in podcast RSS feeds * Add experimental support for podcast:categories on the podcast RSS item * Fix undefined category when no videos exist Allows for empty feeds to exist (important for feeds that might only go live) * Add support for podcast:locked -- user has to opt in to show their email * Use comma for podcast:categories delimiter * Make cache clearing async * Fix merge, temporarily test with pfeed-podcast * Syntax changes * Add EXT_MIMETYPE constants for captions * Update & fix tests, fix enclosure mimetypes, remove admin email * Add test for podacst:socialInteract * Add filters hooks for podcast customTags * Remove showdown, updated to pfeed-podcast 6.1.2 * Add 'action:api.live-video.state.updated' hook * Avoid assigning undefined category to podcast feeds * Remove nvmrc * Remove comment * Remove unused podcast config * Remove more unused podcast config * Fix MChannelAccountDefault type hint missed in merge * Remove extra line * Re-add newline in config * Fix lint errors for isEmailPublic * Fix thumbnails in podcast feeds * Requested changes based on review * Provide podcast rss 2.0 only on video channels * Misc cleanup for a less messy PR * Lint fixes * Remove pfeed-podcast * Add peertube version to new hooks * Don't use query include, remove TODO * Remove film medium hack * Clear podcast rss cache before video/channel update hooks * Clear podcast rss cache before video uploaded/deleted hooks * Refactor podcast feed cache clearing * Set correct person name from video channel * Styling * Fix tests --------- Co-authored-by: Chocobozzz <me@florianbigard.com>
2023-05-22 16:00:05 +02:00
url: t.getOriginFileUrl(video),
2021-12-16 16:49:43 +01:00
path: t.getPath()
}))
return {
webtorrent: { // TODO: remove in v7
videoFiles: webVideoFiles
},
webVideo: {
videoFiles: webVideoFiles
2021-12-16 16:49:43 +01:00
},
hls: {
videoFiles: hlsVideoFiles
},
thumbnails
}
}
}
}
2020-04-30 08:46:40 +02:00
2020-05-07 14:58:24 +02:00
function buildModerationHelpers () {
return {
blockServer: async (options: { byAccountId: number, hostToBlock: string }) => {
const serverToBlock = await ServerModel.loadOrCreateByHost(options.hostToBlock)
2024-02-12 10:47:52 +01:00
const user = await UserModel.loadByAccountId(options.byAccountId)
2020-05-07 14:58:24 +02:00
2024-02-12 10:47:52 +01:00
await addServerInBlocklist({
byAccountId: options.byAccountId,
targetServerId: serverToBlock.id,
removeNotificationOfUserId: user?.id
})
2020-05-07 14:58:24 +02:00
},
unblockServer: async (options: { byAccountId: number, hostToUnblock: string }) => {
const serverBlock = await ServerBlocklistModel.loadByAccountAndHost(options.byAccountId, options.hostToUnblock)
if (!serverBlock) return
await removeServerFromBlocklist(serverBlock)
},
blockAccount: async (options: { byAccountId: number, handleToBlock: string }) => {
const accountToBlock = await AccountModel.loadByNameWithHost(options.handleToBlock)
if (!accountToBlock) return
2024-02-12 10:47:52 +01:00
const user = await UserModel.loadByAccountId(options.byAccountId)
await addAccountInBlocklist({
byAccountId: options.byAccountId,
targetAccountId: accountToBlock.id,
removeNotificationOfUserId: user?.id
})
2020-05-07 14:58:24 +02:00
},
unblockAccount: async (options: { byAccountId: number, handleToUnblock: string }) => {
const targetAccount = await AccountModel.loadByNameWithHost(options.handleToUnblock)
if (!targetAccount) return
const accountBlock = await AccountBlocklistModel.loadByAccountAndTarget(options.byAccountId, targetAccount.id)
if (!accountBlock) return
await removeAccountFromBlocklist(accountBlock)
},
blacklistVideo: async (options: { videoIdOrUUID: number | string, createOptions: VideoBlacklistCreate }) => {
2022-06-28 14:57:51 +02:00
const video = await VideoModel.loadFull(options.videoIdOrUUID)
2020-05-07 14:58:24 +02:00
if (!video) return
await blacklistVideo(video, options.createOptions)
},
unblacklistVideo: async (options: { videoIdOrUUID: number | string }) => {
2022-06-28 14:57:51 +02:00
const video = await VideoModel.loadFull(options.videoIdOrUUID)
2020-05-07 14:58:24 +02:00
if (!video) return
const videoBlacklist = await VideoBlacklistModel.loadByVideoId(video.id)
if (!videoBlacklist) return
await unblacklistVideo(videoBlacklist, video)
}
}
}
2020-04-30 08:46:40 +02:00
function buildConfigHelpers () {
return {
getWebserverUrl () {
return WEBSERVER.URL
2021-04-09 14:51:28 +02:00
},
getServerListeningConfig () {
return { hostname: CONFIG.LISTEN.HOSTNAME, port: CONFIG.LISTEN.PORT }
},
2021-04-09 14:51:28 +02:00
getServerConfig () {
return ServerConfigManager.Instance.getServerConfig()
2020-04-30 08:46:40 +02:00
}
}
}
2021-04-09 14:51:28 +02:00
function buildPluginRelatedHelpers (plugin: MPlugin, npmName: string) {
return {
getBaseStaticRoute: () => `/plugins/${plugin.name}/${plugin.version}/static/`,
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 () {
2021-04-09 14:51:28 +02:00
return {
2022-08-02 15:29:00 +02:00
loadById: (id: number) => {
return UserModel.loadByIdFull(id)
},
getAuthUser: (res: express.Response) => {
const user = res.locals.oauth?.token?.User || res.locals.videoFileToken?.user
if (!user) return undefined
return UserModel.loadByIdFull(user.id)
}
2021-04-09 14:51:28 +02:00
}
}