1 import { PluginSettingsManager } from '@shared/models/plugins/plugin-settings-manager.model'
2 import { PluginModel } from '@server/models/server/plugin'
3 import { PluginStorageManager } from '@shared/models/plugins/plugin-storage-manager.model'
4 import { PluginVideoLanguageManager } from '@shared/models/plugins/plugin-video-language-manager.model'
9 VIDEO_PLAYLIST_PRIVACIES,
11 } from '@server/initializers/constants'
12 import { PluginVideoLicenceManager } from '@shared/models/plugins/plugin-video-licence-manager.model'
13 import { PluginVideoCategoryManager } from '@shared/models/plugins/plugin-video-category-manager.model'
14 import { RegisterServerOptions } from '@server/typings/plugins'
15 import { buildPluginHelpers } from './plugin-helpers'
16 import { logger } from '@server/helpers/logger'
17 import { RegisterServerHookOptions } from '@shared/models/plugins/register-server-hook.model'
18 import { serverHookObject } from '@shared/models/plugins/server-hook.model'
19 import { RegisterServerSettingOptions } from '@shared/models/plugins/register-server-setting.model'
20 import * as express from 'express'
21 import { PluginVideoPrivacyManager } from '@shared/models/plugins/plugin-video-privacy-manager.model'
22 import { PluginPlaylistPrivacyManager } from '@shared/models/plugins/plugin-playlist-privacy-manager.model'
24 type AlterableVideoConstant = 'language' | 'licence' | 'category' | 'privacy' | 'playlistPrivacy'
25 type VideoConstant = { [key in number | string]: string }
27 type UpdatedVideoConstant = {
28 [name in AlterableVideoConstant]: {
29 added: { key: number | string, label: string }[]
30 deleted: { key: number | string, label: string }[]
34 export class RegisterHelpersStore {
35 private readonly updatedVideoConstants: UpdatedVideoConstant = {
36 playlistPrivacy: { added: [], deleted: [] },
37 privacy: { added: [], deleted: [] },
38 language: { added: [], deleted: [] },
39 licence: { added: [], deleted: [] },
40 category: { added: [], deleted: [] }
43 private readonly settings: RegisterServerSettingOptions[] = []
45 private readonly router: express.Router
48 private readonly npmName: string,
49 private readonly plugin: PluginModel,
50 private readonly onHookAdded: (options: RegisterServerHookOptions) => void
52 this.router = express.Router()
55 buildRegisterHelpers (): RegisterServerOptions {
56 const registerHook = this.buildRegisterHook()
57 const registerSetting = this.buildRegisterSetting()
59 const getRouter = this.buildGetRouter()
61 const settingsManager = this.buildSettingsManager()
62 const storageManager = this.buildStorageManager()
64 const videoLanguageManager = this.buildVideoLanguageManager()
66 const videoLicenceManager = this.buildVideoLicenceManager()
67 const videoCategoryManager = this.buildVideoCategoryManager()
69 const videoPrivacyManager = this.buildVideoPrivacyManager()
70 const playlistPrivacyManager = this.buildPlaylistPrivacyManager()
72 const peertubeHelpers = buildPluginHelpers(this.npmName)
88 playlistPrivacyManager,
94 reinitVideoConstants (npmName: string) {
96 language: VIDEO_LANGUAGES,
97 licence: VIDEO_LICENCES,
98 category: VIDEO_CATEGORIES,
99 privacy: VIDEO_PRIVACIES,
100 playlistPrivacy: VIDEO_PLAYLIST_PRIVACIES
102 const types: AlterableVideoConstant[] = [ 'language', 'licence', 'category', 'privacy', 'playlistPrivacy' ]
104 for (const type of types) {
105 const updatedConstants = this.updatedVideoConstants[type][npmName]
106 if (!updatedConstants) continue
108 for (const added of updatedConstants.added) {
109 delete hash[type][added.key]
112 for (const deleted of updatedConstants.deleted) {
113 hash[type][deleted.key] = deleted.label
116 delete this.updatedVideoConstants[type][npmName]
128 private buildGetRouter () {
129 return () => this.router
132 private buildRegisterSetting () {
133 return (options: RegisterServerSettingOptions) => {
134 this.settings.push(options)
138 private buildRegisterHook () {
139 return (options: RegisterServerHookOptions) => {
140 if (serverHookObject[options.target] !== true) {
141 logger.warn('Unknown hook %s of plugin %s. Skipping.', options.target, this.npmName)
145 return this.onHookAdded(options)
149 private buildSettingsManager (): PluginSettingsManager {
151 getSetting: (name: string) => PluginModel.getSetting(this.plugin.name, this.plugin.type, name),
153 setSetting: (name: string, value: string) => PluginModel.setSetting(this.plugin.name, this.plugin.type, name, value)
157 private buildStorageManager (): PluginStorageManager {
159 getData: (key: string) => PluginModel.getData(this.plugin.name, this.plugin.type, key),
161 storeData: (key: string, data: any) => PluginModel.storeData(this.plugin.name, this.plugin.type, key, data)
165 private buildVideoLanguageManager (): PluginVideoLanguageManager {
167 addLanguage: (key: string, label: string) => {
168 return this.addConstant({ npmName: this.npmName, type: 'language', obj: VIDEO_LANGUAGES, key, label })
171 deleteLanguage: (key: string) => {
172 return this.deleteConstant({ npmName: this.npmName, type: 'language', obj: VIDEO_LANGUAGES, key })
177 private buildVideoCategoryManager (): PluginVideoCategoryManager {
179 addCategory: (key: number, label: string) => {
180 return this.addConstant({ npmName: this.npmName, type: 'category', obj: VIDEO_CATEGORIES, key, label })
183 deleteCategory: (key: number) => {
184 return this.deleteConstant({ npmName: this.npmName, type: 'category', obj: VIDEO_CATEGORIES, key })
189 private buildVideoPrivacyManager (): PluginVideoPrivacyManager {
191 deletePrivacy: (key: number) => {
192 return this.deleteConstant({ npmName: this.npmName, type: 'privacy', obj: VIDEO_PRIVACIES, key })
197 private buildPlaylistPrivacyManager (): PluginPlaylistPrivacyManager {
199 deletePlaylistPrivacy: (key: number) => {
200 return this.deleteConstant({ npmName: this.npmName, type: 'playlistPrivacy', obj: VIDEO_PLAYLIST_PRIVACIES, key })
205 private buildVideoLicenceManager (): PluginVideoLicenceManager {
207 addLicence: (key: number, label: string) => {
208 return this.addConstant({ npmName: this.npmName, type: 'licence', obj: VIDEO_LICENCES, key, label })
211 deleteLicence: (key: number) => {
212 return this.deleteConstant({ npmName: this.npmName, type: 'licence', obj: VIDEO_LICENCES, key })
217 private addConstant<T extends string | number> (parameters: {
219 type: AlterableVideoConstant
224 const { npmName, type, obj, key, label } = parameters
227 logger.warn('Cannot add %s %s by plugin %s: key already exists.', type, npmName, key)
231 if (!this.updatedVideoConstants[type][npmName]) {
232 this.updatedVideoConstants[type][npmName] = {
238 this.updatedVideoConstants[type][npmName].added.push({ key, label })
244 private deleteConstant<T extends string | number> (parameters: {
246 type: AlterableVideoConstant
250 const { npmName, type, obj, key } = parameters
253 logger.warn('Cannot delete %s %s by plugin %s: key does not exist.', type, npmName, key)
257 if (!this.updatedVideoConstants[type][npmName]) {
258 this.updatedVideoConstants[type][npmName] = {
264 this.updatedVideoConstants[type][npmName].deleted.push({ key, label: obj[key] })