aboutsummaryrefslogtreecommitdiffhomepage
path: root/server/lib/plugins/register-helpers.ts
blob: 4c0935a05b76a9c3e9685148ae1876eee056edfb (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
import { PluginSettingsManager } from '@shared/models/plugins/plugin-settings-manager.model'
import { PluginModel } from '@server/models/server/plugin'
import { PluginStorageManager } from '@shared/models/plugins/plugin-storage-manager.model'
import { PluginVideoLanguageManager } from '@shared/models/plugins/plugin-video-language-manager.model'
import { VIDEO_CATEGORIES, VIDEO_LANGUAGES, VIDEO_LICENCES } from '@server/initializers/constants'
import { PluginVideoLicenceManager } from '@shared/models/plugins/plugin-video-licence-manager.model'
import { PluginVideoCategoryManager } from '@shared/models/plugins/plugin-video-category-manager.model'
import { RegisterServerOptions } from '@server/typings/plugins'
import { buildPluginHelpers } from './plugin-helpers'
import { logger } from '@server/helpers/logger'

type AlterableVideoConstant = 'language' | 'licence' | 'category'
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 }[]
    }
  }
}

const updatedVideoConstants: UpdatedVideoConstant = {
  language: {},
  licence: {},
  category: {}
}

function buildRegisterHelpers (npmName: string, plugin: PluginModel): Omit<RegisterServerOptions, 'registerHook' | 'registerSetting'> {
  const settingsManager = buildSettingsManager(plugin)
  const storageManager = buildStorageManager(plugin)

  const videoLanguageManager = buildVideoLanguageManager(npmName)

  const videoCategoryManager = buildVideoCategoryManager(npmName)
  const videoLicenceManager = buildVideoLicenceManager(npmName)

  const peertubeHelpers = buildPluginHelpers(npmName)

  return {
    settingsManager,
    storageManager,
    videoLanguageManager,
    videoCategoryManager,
    videoLicenceManager,
    peertubeHelpers
  }
}

function reinitVideoConstants (npmName: string) {
  const hash = {
    language: VIDEO_LANGUAGES,
    licence: VIDEO_LICENCES,
    category: VIDEO_CATEGORIES
  }
  const types: AlterableVideoConstant[] = [ 'language', 'licence', 'category' ]

  for (const type of types) {
    const updatedConstants = 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 updatedVideoConstants[type][npmName]
  }
}

export {
  buildRegisterHelpers,
  reinitVideoConstants
}

// ---------------------------------------------------------------------------

function buildSettingsManager (plugin: PluginModel): PluginSettingsManager {
  return {
    getSetting: (name: string) => PluginModel.getSetting(plugin.name, plugin.type, name),

    setSetting: (name: string, value: string) => PluginModel.setSetting(plugin.name, plugin.type, name, value)
  }
}

function buildStorageManager (plugin: PluginModel): PluginStorageManager {
  return {
    getData: (key: string) => PluginModel.getData(plugin.name, plugin.type, key),

    storeData: (key: string, data: any) => PluginModel.storeData(plugin.name, plugin.type, key, data)
  }
}

function buildVideoLanguageManager (npmName: string): PluginVideoLanguageManager {
  return {
    addLanguage: (key: string, label: string) => addConstant({ npmName, type: 'language', obj: VIDEO_LANGUAGES, key, label }),

    deleteLanguage: (key: string) => deleteConstant({ npmName, type: 'language', obj: VIDEO_LANGUAGES, key })
  }
}

function buildVideoCategoryManager (npmName: string): PluginVideoCategoryManager {
  return {
    addCategory: (key: number, label: string) => {
      return addConstant({ npmName, type: 'category', obj: VIDEO_CATEGORIES, key, label })
    },

    deleteCategory: (key: number) => {
      return deleteConstant({ npmName, type: 'category', obj: VIDEO_CATEGORIES, key })
    }
  }
}

function buildVideoLicenceManager (npmName: string): PluginVideoLicenceManager {
  return {
    addLicence: (key: number, label: string) => {
      return addConstant({ npmName, type: 'licence', obj: VIDEO_LICENCES, key, label })
    },

    deleteLicence: (key: number) => {
      return deleteConstant({ npmName, type: 'licence', obj: VIDEO_LICENCES, key })
    }
  }
}

function 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 (!updatedVideoConstants[type][npmName]) {
    updatedVideoConstants[type][npmName] = {
      added: [],
      deleted: []
    }
  }

  updatedVideoConstants[type][npmName].added.push({ key, label })
  obj[key] = label

  return true
}

function 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 %s by plugin %s: key does not exist.', type, npmName, key)
    return false
  }

  if (!updatedVideoConstants[type][npmName]) {
    updatedVideoConstants[type][npmName] = {
      added: [],
      deleted: []
    }
  }

  updatedVideoConstants[type][npmName].deleted.push({ key, label: obj[key] })
  delete obj[key]

  return true
}