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

134 lines
4.2 KiB
TypeScript
Raw Normal View History

2020-06-23 14:10:17 +02:00
import { PeerTubeHelpers } from '@server/types/plugins'
2020-04-09 11:00:30 +02:00
import { sequelizeTypescript } from '@server/initializers/database'
import { buildLogger } from '@server/helpers/logger'
import { VideoModel } from '@server/models/video/video'
2020-04-30 08:46:40 +02:00
import { WEBSERVER } from '@server/initializers/constants'
2020-05-07 14:58:24 +02:00
import { ServerModel } from '@server/models/server/server'
import { getServerActor } from '@server/models/application/application'
import { addServerInBlocklist, removeServerFromBlocklist, addAccountInBlocklist, removeAccountFromBlocklist } from '../blocklist'
import { ServerBlocklistModel } from '@server/models/server/server-blocklist'
import { AccountModel } from '@server/models/account/account'
import { VideoBlacklistCreate } from '@shared/models'
import { blacklistVideo, unblacklistVideo } from '../video-blacklist'
import { VideoBlacklistModel } from '@server/models/video/video-blacklist'
import { AccountBlocklistModel } from '@server/models/account/account-blocklist'
2020-04-09 09:57:32 +02:00
2020-04-09 11:00:30 +02:00
function buildPluginHelpers (npmName: string): PeerTubeHelpers {
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()
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,
server
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)
},
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
}
}
}