Commit dc3d9022 authored by lutangar's avatar lutangar
Browse files

Introduce generic video constant manager for plugins

Allow a plugin developer to get back constants values,
and reset constants deletions or additions.
parent de15b052
import * as express from 'express'
import { logger } from '@server/helpers/logger'
import {
VIDEO_CATEGORIES,
VIDEO_LANGUAGES,
VIDEO_LICENCES,
VIDEO_PLAYLIST_PRIVACIES,
VIDEO_PRIVACIES
} from '@server/initializers/constants'
import { onExternalUserAuthenticated } from '@server/lib/auth/external-auth'
import { VideoConstantManagerFactory } from '@server/lib/plugins/video-constant-manager-factory'
import { PluginModel } from '@server/models/server/plugin'
import {
RegisterServerAuthExternalOptions,
......@@ -18,41 +12,18 @@ import {
} from '@server/types/plugins'
import {
EncoderOptionsBuilder,
PluginPlaylistPrivacyManager,
PluginSettingsManager,
PluginStorageManager,
PluginVideoCategoryManager,
PluginVideoLanguageManager,
PluginVideoLicenceManager,
PluginVideoPrivacyManager,
RegisterServerHookOptions,
RegisterServerSettingOptions,
serverHookObject
serverHookObject,
VideoPlaylistPrivacy,
VideoPrivacy
} from '@shared/models'
import { VideoTranscodingProfilesManager } from '../transcoding/video-transcoding-profiles'
import { buildPluginHelpers } from './plugin-helpers-builder'
type AlterableVideoConstant = 'language' | 'licence' | 'category' | 'privacy' | 'playlistPrivacy'
type VideoConstant = { [key in number | string]: string }
type UpdatedVideoConstant = {
[name in AlterableVideoConstant]: {
[ npmName: string]: {
added: { key: number | string, label: string }[]
deleted: { key: number | string, label: string }[]
}
}
}
export class RegisterHelpers {
private readonly updatedVideoConstants: UpdatedVideoConstant = {
playlistPrivacy: { },
privacy: { },
language: { },
licence: { },
category: { }
}
private readonly transcodingProfiles: {
[ npmName: string ]: {
type: 'vod' | 'live'
......@@ -78,6 +49,7 @@ export class RegisterHelpers {
private readonly onSettingsChangeCallbacks: ((settings: any) => Promise<any>)[] = []
private readonly router: express.Router
private readonly videoConstantManagerFactory: VideoConstantManagerFactory
constructor (
private readonly npmName: string,
......@@ -85,6 +57,7 @@ export class RegisterHelpers {
private readonly onHookAdded: (options: RegisterServerHookOptions) => void
) {
this.router = express.Router()
this.videoConstantManagerFactory = new VideoConstantManagerFactory(this.npmName)
}
buildRegisterHelpers (): RegisterServerOptions {
......@@ -96,13 +69,13 @@ export class RegisterHelpers {
const settingsManager = this.buildSettingsManager()
const storageManager = this.buildStorageManager()
const videoLanguageManager = this.buildVideoLanguageManager()
const videoLanguageManager = this.videoConstantManagerFactory.createVideoConstantManager<string>('language')
const videoLicenceManager = this.buildVideoLicenceManager()
const videoCategoryManager = this.buildVideoCategoryManager()
const videoLicenceManager = this.videoConstantManagerFactory.createVideoConstantManager<number>('licence')
const videoCategoryManager = this.videoConstantManagerFactory.createVideoConstantManager<number>('category')
const videoPrivacyManager = this.buildVideoPrivacyManager()
const playlistPrivacyManager = this.buildPlaylistPrivacyManager()
const videoPrivacyManager = this.videoConstantManagerFactory.createVideoConstantManager<VideoPrivacy>('privacy')
const playlistPrivacyManager = this.videoConstantManagerFactory.createVideoConstantManager<VideoPlaylistPrivacy>('playlistPrivacy')
const transcodingManager = this.buildTranscodingManager()
......@@ -122,12 +95,38 @@ export class RegisterHelpers {
settingsManager,
storageManager,
videoLanguageManager,
videoCategoryManager,
videoLicenceManager,
videoLanguageManager: {
...videoLanguageManager,
/** @deprecated use `addConstant` instead **/
addLanguage: videoLanguageManager.addConstant,
/** @deprecated use `deleteConstant` instead **/
deleteLanguage: videoLanguageManager.deleteConstant
},
videoCategoryManager: {
...videoCategoryManager,
/** @deprecated use `addConstant` instead **/
addCategory: videoCategoryManager.addConstant,
/** @deprecated use `deleteConstant` instead **/
deleteCategory: videoCategoryManager.deleteConstant
},
videoLicenceManager: {
...videoLicenceManager,
/** @deprecated use `addConstant` instead **/
addLicence: videoLicenceManager.addConstant,
/** @deprecated use `deleteConstant` instead **/
deleteLicence: videoLicenceManager.deleteConstant
},
videoPrivacyManager,
playlistPrivacyManager,
videoPrivacyManager: {
...videoPrivacyManager,
/** @deprecated use `deleteConstant` instead **/
deletePrivacy: videoPrivacyManager.deleteConstant
},
playlistPrivacyManager: {
...playlistPrivacyManager,
/** @deprecated use `deleteConstant` instead **/
deletePlaylistPrivacy: playlistPrivacyManager.deleteConstant
},
transcodingManager,
......@@ -141,29 +140,7 @@ export class RegisterHelpers {
}
reinitVideoConstants (npmName: string) {
const hash = {
language: VIDEO_LANGUAGES,
licence: VIDEO_LICENCES,
category: VIDEO_CATEGORIES,
privacy: VIDEO_PRIVACIES,
playlistPrivacy: VIDEO_PLAYLIST_PRIVACIES
}
const types: AlterableVideoConstant[] = [ 'language', 'licence', 'category', 'privacy', 'playlistPrivacy' ]
for (const type of types) {
const updatedConstants = this.updatedVideoConstants[type][npmName]
if (!updatedConstants) continue
for (const added of updatedConstants.added) {
delete hash[type][added.key]
}
for (const deleted of updatedConstants.deleted) {
hash[type][deleted.key] = deleted.label
}
delete this.updatedVideoConstants[type][npmName]
}
this.videoConstantManagerFactory.resetVideoConstants(npmName)
}
reinitTranscodingProfilesAndEncoders (npmName: string) {
......@@ -291,119 +268,6 @@ export class RegisterHelpers {
}
}
private buildVideoLanguageManager (): PluginVideoLanguageManager {
return {
addLanguage: (key: string, label: string) => {
return this.addConstant({ npmName: this.npmName, type: 'language', obj: VIDEO_LANGUAGES, key, label })
},
deleteLanguage: (key: string) => {
return this.deleteConstant({ npmName: this.npmName, type: 'language', obj: VIDEO_LANGUAGES, key })
}
}
}
private buildVideoCategoryManager (): PluginVideoCategoryManager {
return {
addCategory: (key: number, label: string) => {
return this.addConstant({ npmName: this.npmName, type: 'category', obj: VIDEO_CATEGORIES, key, label })
},
deleteCategory: (key: number) => {
return this.deleteConstant({ npmName: this.npmName, type: 'category', obj: VIDEO_CATEGORIES, key })
}
}
}
private buildVideoPrivacyManager (): PluginVideoPrivacyManager {
return {
deletePrivacy: (key: number) => {
return this.deleteConstant({ npmName: this.npmName, type: 'privacy', obj: VIDEO_PRIVACIES, key })
}
}
}
private buildPlaylistPrivacyManager (): PluginPlaylistPrivacyManager {
return {
deletePlaylistPrivacy: (key: number) => {
return this.deleteConstant({ npmName: this.npmName, type: 'playlistPrivacy', obj: VIDEO_PLAYLIST_PRIVACIES, key })
}
}
}
private buildVideoLicenceManager (): PluginVideoLicenceManager {
return {
addLicence: (key: number, label: string) => {
return this.addConstant({ npmName: this.npmName, type: 'licence', obj: VIDEO_LICENCES, key, label })
},
deleteLicence: (key: number) => {
return this.deleteConstant({ npmName: this.npmName, type: 'licence', obj: VIDEO_LICENCES, key })
}
}
}
private addConstant<T extends string | number> (parameters: {
npmName: string
type: AlterableVideoConstant
obj: VideoConstant
key: T
label: string
}) {
const { npmName, type, obj, key, label } = parameters
if (obj[key]) {
logger.warn('Cannot add %s %s by plugin %s: key already exists.', type, npmName, key)
return false
}
if (!this.updatedVideoConstants[type][npmName]) {
this.updatedVideoConstants[type][npmName] = {
added: [],
deleted: []
}
}
this.updatedVideoConstants[type][npmName].added.push({ key, label })
obj[key] = label
return true
}
private deleteConstant<T extends string | number> (parameters: {
npmName: string
type: AlterableVideoConstant
obj: VideoConstant
key: T
}) {
const { npmName, type, obj, key } = parameters
if (!obj[key]) {
logger.warn('Cannot delete %s by plugin %s: key %s does not exist.', type, npmName, key)
return false
}
if (!this.updatedVideoConstants[type][npmName]) {
this.updatedVideoConstants[type][npmName] = {
added: [],
deleted: []
}
}
const updatedConstants = this.updatedVideoConstants[type][npmName]
const alreadyAdded = updatedConstants.added.find(a => a.key === key)
if (alreadyAdded) {
updatedConstants.added.filter(a => a.key !== key)
} else if (obj[key]) {
updatedConstants.deleted.push({ key, label: obj[key] })
}
delete obj[key]
return true
}
private buildTranscodingManager () {
const self = this
......
import { logger } from '@server/helpers/logger'
import {
VIDEO_CATEGORIES,
VIDEO_LANGUAGES,
VIDEO_LICENCES,
VIDEO_PLAYLIST_PRIVACIES,
VIDEO_PRIVACIES
} from '@server/initializers/constants'
import { ConstantManager } from '@shared/models/plugins/server/plugin-constant-manager.model'
type AlterableVideoConstant = 'language' | 'licence' | 'category' | 'privacy' | 'playlistPrivacy'
type VideoConstant = Record<number | string, string>
type UpdatedVideoConstant = {
[name in AlterableVideoConstant]: {
[ npmName: string]: {
added: VideoConstant[]
deleted: VideoConstant[]
}
}
}
const constantsHash: { [key in AlterableVideoConstant]: VideoConstant } = {
language: VIDEO_LANGUAGES,
licence: VIDEO_LICENCES,
category: VIDEO_CATEGORIES,
privacy: VIDEO_PRIVACIES,
playlistPrivacy: VIDEO_PLAYLIST_PRIVACIES
}
export class VideoConstantManagerFactory {
private readonly updatedVideoConstants: UpdatedVideoConstant = {
playlistPrivacy: { },
privacy: { },
language: { },
licence: { },
category: { }
}
constructor (
private readonly npmName: string
) {}
public resetVideoConstants (npmName: string) {
const types: AlterableVideoConstant[] = [ 'language', 'licence', 'category', 'privacy', 'playlistPrivacy' ]
for (const type of types) {
this.resetConstants({ npmName, type })
}
}
private resetConstants (parameters: { npmName: string, type: AlterableVideoConstant }) {
const { npmName, type } = parameters
const updatedConstants = this.updatedVideoConstants[type][npmName]
if (!updatedConstants) return
for (const added of updatedConstants.added) {
delete constantsHash[type][added.key]
}
for (const deleted of updatedConstants.deleted) {
constantsHash[type][deleted.key] = deleted.label
}
delete this.updatedVideoConstants[type][npmName]
}
public createVideoConstantManager<K extends number | string>(type: AlterableVideoConstant): ConstantManager<K> {
const { npmName } = this
return {
addConstant: (key: K, label: string) => this.addConstant({ npmName, type, key, label }),
deleteConstant: (key: K) => this.deleteConstant({ npmName, type, key }),
getConstantValue: (key: K) => constantsHash[type][key],
getConstants: () => constantsHash[type] as Record<K, string>,
resetConstants: () => this.resetConstants({ npmName, type })
}
}
private addConstant<T extends string | number> (parameters: {
npmName: string
type: AlterableVideoConstant
key: T
label: string
}) {
const { npmName, type, key, label } = parameters
const obj = constantsHash[type]
if (obj[key]) {
logger.warn('Cannot add %s %s by plugin %s: key already exists.', type, npmName, key)
return false
}
if (!this.updatedVideoConstants[type][npmName]) {
this.updatedVideoConstants[type][npmName] = {
added: [],
deleted: []
}
}
this.updatedVideoConstants[type][npmName].added.push({ key: key, label } as VideoConstant)
obj[key] = label
return true
}
private deleteConstant<T extends string | number> (parameters: {
npmName: string
type: AlterableVideoConstant
key: T
}) {
const { npmName, type, key } = parameters
const obj = constantsHash[type]
if (!obj[key]) {
logger.warn('Cannot delete %s by plugin %s: key %s does not exist.', type, npmName, key)
return false
}
if (!this.updatedVideoConstants[type][npmName]) {
this.updatedVideoConstants[type][npmName] = {
added: [],
deleted: []
}
}
const updatedConstants = this.updatedVideoConstants[type][npmName]
const alreadyAdded = updatedConstants.added.find(a => a.key === key)
if (alreadyAdded) {
updatedConstants.added.filter(a => a.key !== key)
} else if (obj[key]) {
updatedConstants.deleted.push({ key, label: obj[key] } as VideoConstant)
}
delete obj[key]
return true
}
}
async function register ({
registerHook,
registerSetting,
settingsManager,
storageManager,
videoCategoryManager,
videoLicenceManager,
videoLanguageManager,
videoPrivacyManager,
playlistPrivacyManager
playlistPrivacyManager,
getRouter
}) {
videoLanguageManager.addLanguage('al_bhed', 'Al Bhed')
videoLanguageManager.addLanguage('al_bhed2', 'Al Bhed 2')
videoLanguageManager.addLanguage('al_bhed3', 'Al Bhed 3')
videoLanguageManager.deleteLanguage('en')
videoLanguageManager.deleteLanguage('fr')
videoLanguageManager.deleteLanguage('al_bhed3')
videoLanguageManager.addConstant('al_bhed', 'Al Bhed')
videoLanguageManager.addConstant('al_bhed2', 'Al Bhed 2')
videoLanguageManager.addConstant('al_bhed3', 'Al Bhed 3')
videoLanguageManager.deleteConstant('en')
videoLanguageManager.deleteConstant('fr')
videoLanguageManager.deleteConstant('al_bhed3')
videoCategoryManager.addCategory(42, 'Best category')
videoCategoryManager.addCategory(43, 'High best category')
videoCategoryManager.deleteCategory(1) // Music
videoCategoryManager.deleteCategory(2) // Films
videoCategoryManager.addConstant(42, 'Best category')
videoCategoryManager.addConstant(43, 'High best category')
videoCategoryManager.deleteConstant(1) // Music
videoCategoryManager.deleteConstant(2) // Films
videoLicenceManager.addLicence(42, 'Best licence')
videoLicenceManager.addLicence(43, 'High best licence')
videoLicenceManager.deleteLicence(1) // Attribution
videoLicenceManager.deleteLicence(7) // Public domain
videoLicenceManager.addConstant(42, 'Best licence')
videoLicenceManager.addConstant(43, 'High best licence')
videoLicenceManager.deleteConstant(1) // Attribution
videoLicenceManager.deleteConstant(7) // Public domain
videoPrivacyManager.deletePrivacy(2)
playlistPrivacyManager.deletePlaylistPrivacy(3)
}
videoPrivacyManager.deleteConstant(2)
playlistPrivacyManager.deleteConstant(3)
{
const router = getRouter()
router.get('/reset-categories', (req, res) => {
videoCategoryManager.resetConstants()
async function unregister () {
return
res.sendStatus(204)
})
}
}
async function unregister () {}
module.exports = {
register,
unregister
}
// ############################################################################
function addToCount (obj) {
return Object.assign({}, obj, { count: obj.count + 1 })
}
/* eslint-disable @typescript-eslint/no-unused-expressions */
import 'mocha'
import { expect } from 'chai'
import { VideoConstantManagerFactory } from '@server/lib/plugins/video-constant-manager-factory'
import {
VIDEO_CATEGORIES,
VIDEO_LANGUAGES,
VIDEO_LICENCES,
VIDEO_PLAYLIST_PRIVACIES,
VIDEO_PRIVACIES
} from '@server/initializers/constants'
import {
VideoPlaylistPrivacy,
VideoPrivacy
} from '@shared/models'
describe('VideoConstantManagerFactory', function () {
const factory = new VideoConstantManagerFactory('peertube-plugin-constants')
afterEach(() => {
factory.resetVideoConstants('peertube-plugin-constants')
})
describe('VideoCategoryManager', () => {
const videoCategoryManager = factory.createVideoConstantManager<number>('category')
it('Should be able to list all video category constants', () => {
const constants = videoCategoryManager.getConstants()
expect(constants).to.deep.equal(VIDEO_CATEGORIES)
})
it('Should be able to delete a video category constant', () => {
const successfullyDeleted = videoCategoryManager.deleteConstant(1)
expect(successfullyDeleted).to.be.true
expect(videoCategoryManager.getConstantValue(1)).to.be.undefined
})
it('Should be able to add a video category constant', () => {
const successfullyAdded = videoCategoryManager.addConstant(42, 'The meaning of life')
expect(successfullyAdded).to.be.true
expect(videoCategoryManager.getConstantValue(42)).to.equal('The meaning of life')
})
it('Should be able to reset video category constants', () => {
videoCategoryManager.deleteConstant(1)
videoCategoryManager.resetConstants()
expect(videoCategoryManager.getConstantValue(1)).not.be.undefined
})
})
describe('VideoLicenceManager', () => {
const videoLicenceManager = factory.createVideoConstantManager<number>('licence')
it('Should be able to list all video licence constants', () => {
const constants = videoLicenceManager.getConstants()
expect(constants).to.deep.equal(VIDEO_LICENCES)
})
it('Should be able to delete a video licence constant', () => {
const successfullyDeleted = videoLicenceManager.deleteConstant(1)
expect(successfullyDeleted).to.be.true
expect(videoLicenceManager.getConstantValue(1)).to.be.undefined
})
it('Should be able to add a video licence constant', () => {
const successfullyAdded = videoLicenceManager.addConstant(42, 'European Union Public Licence')
expect(successfullyAdded).to.be.true
expect(videoLicenceManager.getConstantValue(42)).to.equal('European Union Public Licence')
})
it('Should be able to reset video licence constants', () => {
videoLicenceManager.deleteConstant(1)
videoLicenceManager.resetConstants()
expect(videoLicenceManager.getConstantValue(1)).not.be.undefined
})
})
describe('PlaylistPrivacyManager', () => {
const playlistPrivacyManager = factory.createVideoConstantManager<VideoPlaylistPrivacy>('playlistPrivacy')
it('Should be able to list all video playlist privacy constants', () => {
const constants = playlistPrivacyManager.getConstants()
expect(constants).to.deep.equal(VIDEO_PLAYLIST_PRIVACIES)
})
<