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

175 lines
5.3 KiB
TypeScript
Raw Normal View History

2021-08-27 14:32:44 +02:00
import express from 'express'
import { join } from 'path'
2020-04-09 11:00:30 +02:00
import { buildLogger } from '@server/helpers/logger'
import { CONFIG } from '@server/initializers/config'
2020-04-30 08:46:40 +02:00
import { WEBSERVER } from '@server/initializers/constants'
import { sequelizeTypescript } from '@server/initializers/database'
import { AccountModel } from '@server/models/account/account'
import { AccountBlocklistModel } from '@server/models/account/account-blocklist'
2020-05-07 14:58:24 +02:00
import { getServerActor } from '@server/models/application/application'
import { ServerModel } from '@server/models/server/server'
2020-05-07 14:58:24 +02:00
import { ServerBlocklistModel } from '@server/models/server/server-blocklist'
import { VideoModel } from '@server/models/video/video'
2020-05-07 14:58:24 +02:00
import { VideoBlacklistModel } from '@server/models/video/video-blacklist'
2021-04-09 14:51:28 +02:00
import { MPlugin } from '@server/types/models'
import { PeerTubeHelpers } from '@server/types/plugins'
import { VideoBlacklistCreate } from '@shared/models'
import { addAccountInBlocklist, addServerInBlocklist, removeAccountFromBlocklist, removeServerFromBlocklist } from '../blocklist'
import { ServerConfigManager } from '../server-config-manager'
import { blacklistVideo, unblacklistVideo } from '../video-blacklist'
2021-05-11 11:15:29 +02:00
import { UserModel } from '@server/models/user/user'
2020-04-09 09:57:32 +02:00
2021-04-09 14:51:28 +02:00
function buildPluginHelpers (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()
2020-05-07 14:58:24 +02:00
const server = buildServerHelpers()
const moderation = buildModerationHelpers()
const plugin = buildPluginRelatedHelpers(pluginModel, npmName)
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,
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)
}
}
2020-05-07 14:58:24 +02:00
function buildServerHelpers () {
return {
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)
},
removeVideo: (id: number) => {
return sequelizeTypescript.transaction(async t => {
const video = await VideoModel.loadAndPopulateAccountAndServerAndTags(id, t)
await video.destroy({ transaction: t })
})
}
}
}
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)
await addServerInBlocklist(options.byAccountId, serverToBlock.id)
},
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
await addAccountInBlocklist(options.byAccountId, accountToBlock.id)
},
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 }) => {
const video = await VideoModel.loadAndPopulateAccountAndServerAndTags(options.videoIdOrUUID)
if (!video) return
await blacklistVideo(video, options.createOptions)
},
unblacklistVideo: async (options: { videoIdOrUUID: number | string }) => {
const video = await VideoModel.loadAndPopulateAccountAndServerAndTags(options.videoIdOrUUID)
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
},
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/`,
getDataDirectoryPath: () => join(CONFIG.STORAGE.PLUGINS_DIR, 'data', npmName)
}
}
function buildUserHelpers () {
2021-04-09 14:51:28 +02:00
return {
getAuthUser: (res: express.Response) => {
const user = res.locals.oauth?.token?.User
if (!user) return undefined
return UserModel.loadByIdFull(user.id)
}
2021-04-09 14:51:28 +02:00
}
}