]>
Commit | Line | Data |
---|---|---|
5e2b2e27 C |
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' | |
b3af2601 C |
5 | import { |
6 | VIDEO_CATEGORIES, | |
7 | VIDEO_LANGUAGES, | |
8 | VIDEO_LICENCES, | |
9 | VIDEO_PLAYLIST_PRIVACIES, | |
10 | VIDEO_PRIVACIES | |
11 | } from '@server/initializers/constants' | |
5e2b2e27 C |
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' | |
b3af2601 C |
21 | import { PluginVideoPrivacyManager } from '@shared/models/plugins/plugin-video-privacy-manager.model' |
22 | import { PluginPlaylistPrivacyManager } from '@shared/models/plugins/plugin-playlist-privacy-manager.model' | |
7fed6375 C |
23 | import { |
24 | RegisterServerAuthExternalOptions, | |
25 | RegisterServerAuthExternalResult, | |
26 | RegisterServerAuthPassOptions | |
27 | } from '@shared/models/plugins/register-server-auth.model' | |
28 | import { onExternalAuthPlugin } from '@server/lib/auth' | |
5e2b2e27 | 29 | |
b3af2601 | 30 | type AlterableVideoConstant = 'language' | 'licence' | 'category' | 'privacy' | 'playlistPrivacy' |
5e2b2e27 C |
31 | type VideoConstant = { [key in number | string]: string } |
32 | ||
33 | type UpdatedVideoConstant = { | |
34 | [name in AlterableVideoConstant]: { | |
35 | added: { key: number | string, label: string }[] | |
36 | deleted: { key: number | string, label: string }[] | |
37 | } | |
38 | } | |
39 | ||
40 | export class RegisterHelpersStore { | |
41 | private readonly updatedVideoConstants: UpdatedVideoConstant = { | |
b3af2601 C |
42 | playlistPrivacy: { added: [], deleted: [] }, |
43 | privacy: { added: [], deleted: [] }, | |
5e2b2e27 C |
44 | language: { added: [], deleted: [] }, |
45 | licence: { added: [], deleted: [] }, | |
46 | category: { added: [], deleted: [] } | |
47 | } | |
48 | ||
49 | private readonly settings: RegisterServerSettingOptions[] = [] | |
50 | ||
7fed6375 C |
51 | private readonly idAndPassAuths: RegisterServerAuthPassOptions[] = [] |
52 | private readonly externalAuths: RegisterServerAuthExternalOptions[] = [] | |
53 | ||
5e2b2e27 C |
54 | private readonly router: express.Router |
55 | ||
56 | constructor ( | |
57 | private readonly npmName: string, | |
58 | private readonly plugin: PluginModel, | |
59 | private readonly onHookAdded: (options: RegisterServerHookOptions) => void | |
60 | ) { | |
61 | this.router = express.Router() | |
62 | } | |
63 | ||
64 | buildRegisterHelpers (): RegisterServerOptions { | |
65 | const registerHook = this.buildRegisterHook() | |
66 | const registerSetting = this.buildRegisterSetting() | |
67 | ||
68 | const getRouter = this.buildGetRouter() | |
69 | ||
70 | const settingsManager = this.buildSettingsManager() | |
71 | const storageManager = this.buildStorageManager() | |
72 | ||
73 | const videoLanguageManager = this.buildVideoLanguageManager() | |
74 | ||
75 | const videoLicenceManager = this.buildVideoLicenceManager() | |
76 | const videoCategoryManager = this.buildVideoCategoryManager() | |
77 | ||
b3af2601 C |
78 | const videoPrivacyManager = this.buildVideoPrivacyManager() |
79 | const playlistPrivacyManager = this.buildPlaylistPrivacyManager() | |
80 | ||
7fed6375 C |
81 | const registerIdAndPassAuth = this.buildRegisterIdAndPassAuth() |
82 | const registerExternalAuth = this.buildRegisterExternalAuth() | |
83 | ||
5e2b2e27 C |
84 | const peertubeHelpers = buildPluginHelpers(this.npmName) |
85 | ||
86 | return { | |
87 | registerHook, | |
88 | registerSetting, | |
89 | ||
90 | getRouter, | |
91 | ||
92 | settingsManager, | |
93 | storageManager, | |
94 | ||
95 | videoLanguageManager, | |
96 | videoCategoryManager, | |
97 | videoLicenceManager, | |
98 | ||
b3af2601 C |
99 | videoPrivacyManager, |
100 | playlistPrivacyManager, | |
101 | ||
7fed6375 C |
102 | registerIdAndPassAuth, |
103 | registerExternalAuth, | |
104 | ||
5e2b2e27 C |
105 | peertubeHelpers |
106 | } | |
107 | } | |
108 | ||
109 | reinitVideoConstants (npmName: string) { | |
110 | const hash = { | |
111 | language: VIDEO_LANGUAGES, | |
112 | licence: VIDEO_LICENCES, | |
b3af2601 C |
113 | category: VIDEO_CATEGORIES, |
114 | privacy: VIDEO_PRIVACIES, | |
115 | playlistPrivacy: VIDEO_PLAYLIST_PRIVACIES | |
5e2b2e27 | 116 | } |
b3af2601 | 117 | const types: AlterableVideoConstant[] = [ 'language', 'licence', 'category', 'privacy', 'playlistPrivacy' ] |
5e2b2e27 C |
118 | |
119 | for (const type of types) { | |
120 | const updatedConstants = this.updatedVideoConstants[type][npmName] | |
121 | if (!updatedConstants) continue | |
122 | ||
123 | for (const added of updatedConstants.added) { | |
124 | delete hash[type][added.key] | |
125 | } | |
126 | ||
127 | for (const deleted of updatedConstants.deleted) { | |
128 | hash[type][deleted.key] = deleted.label | |
129 | } | |
130 | ||
131 | delete this.updatedVideoConstants[type][npmName] | |
132 | } | |
133 | } | |
134 | ||
135 | getSettings () { | |
136 | return this.settings | |
137 | } | |
138 | ||
139 | getRouter () { | |
140 | return this.router | |
141 | } | |
142 | ||
7fed6375 C |
143 | getIdAndPassAuths () { |
144 | return this.idAndPassAuths | |
145 | } | |
146 | ||
147 | getExternalAuths () { | |
148 | return this.externalAuths | |
149 | } | |
150 | ||
5e2b2e27 C |
151 | private buildGetRouter () { |
152 | return () => this.router | |
153 | } | |
154 | ||
155 | private buildRegisterSetting () { | |
156 | return (options: RegisterServerSettingOptions) => { | |
157 | this.settings.push(options) | |
158 | } | |
159 | } | |
160 | ||
161 | private buildRegisterHook () { | |
162 | return (options: RegisterServerHookOptions) => { | |
163 | if (serverHookObject[options.target] !== true) { | |
164 | logger.warn('Unknown hook %s of plugin %s. Skipping.', options.target, this.npmName) | |
165 | return | |
166 | } | |
167 | ||
168 | return this.onHookAdded(options) | |
169 | } | |
170 | } | |
171 | ||
7fed6375 C |
172 | private buildRegisterIdAndPassAuth () { |
173 | return (options: RegisterServerAuthPassOptions) => { | |
174 | this.idAndPassAuths.push(options) | |
175 | } | |
176 | } | |
177 | ||
178 | private buildRegisterExternalAuth () { | |
179 | const self = this | |
180 | ||
181 | return (options: RegisterServerAuthExternalOptions) => { | |
182 | this.externalAuths.push(options) | |
183 | ||
184 | return { | |
185 | onAuth (options: { username: string, email: string }): void { | |
186 | onExternalAuthPlugin(self.npmName, options.username, options.email) | |
187 | } | |
188 | } as RegisterServerAuthExternalResult | |
189 | } | |
190 | } | |
191 | ||
5e2b2e27 C |
192 | private buildSettingsManager (): PluginSettingsManager { |
193 | return { | |
194 | getSetting: (name: string) => PluginModel.getSetting(this.plugin.name, this.plugin.type, name), | |
195 | ||
196 | setSetting: (name: string, value: string) => PluginModel.setSetting(this.plugin.name, this.plugin.type, name, value) | |
197 | } | |
198 | } | |
199 | ||
200 | private buildStorageManager (): PluginStorageManager { | |
201 | return { | |
202 | getData: (key: string) => PluginModel.getData(this.plugin.name, this.plugin.type, key), | |
203 | ||
204 | storeData: (key: string, data: any) => PluginModel.storeData(this.plugin.name, this.plugin.type, key, data) | |
205 | } | |
206 | } | |
207 | ||
208 | private buildVideoLanguageManager (): PluginVideoLanguageManager { | |
209 | return { | |
210 | addLanguage: (key: string, label: string) => { | |
211 | return this.addConstant({ npmName: this.npmName, type: 'language', obj: VIDEO_LANGUAGES, key, label }) | |
212 | }, | |
213 | ||
214 | deleteLanguage: (key: string) => { | |
215 | return this.deleteConstant({ npmName: this.npmName, type: 'language', obj: VIDEO_LANGUAGES, key }) | |
216 | } | |
217 | } | |
218 | } | |
219 | ||
220 | private buildVideoCategoryManager (): PluginVideoCategoryManager { | |
221 | return { | |
222 | addCategory: (key: number, label: string) => { | |
223 | return this.addConstant({ npmName: this.npmName, type: 'category', obj: VIDEO_CATEGORIES, key, label }) | |
224 | }, | |
225 | ||
226 | deleteCategory: (key: number) => { | |
227 | return this.deleteConstant({ npmName: this.npmName, type: 'category', obj: VIDEO_CATEGORIES, key }) | |
228 | } | |
229 | } | |
230 | } | |
231 | ||
b3af2601 C |
232 | private buildVideoPrivacyManager (): PluginVideoPrivacyManager { |
233 | return { | |
234 | deletePrivacy: (key: number) => { | |
235 | return this.deleteConstant({ npmName: this.npmName, type: 'privacy', obj: VIDEO_PRIVACIES, key }) | |
236 | } | |
237 | } | |
238 | } | |
239 | ||
240 | private buildPlaylistPrivacyManager (): PluginPlaylistPrivacyManager { | |
241 | return { | |
242 | deletePlaylistPrivacy: (key: number) => { | |
243 | return this.deleteConstant({ npmName: this.npmName, type: 'playlistPrivacy', obj: VIDEO_PLAYLIST_PRIVACIES, key }) | |
244 | } | |
245 | } | |
246 | } | |
247 | ||
5e2b2e27 C |
248 | private buildVideoLicenceManager (): PluginVideoLicenceManager { |
249 | return { | |
250 | addLicence: (key: number, label: string) => { | |
251 | return this.addConstant({ npmName: this.npmName, type: 'licence', obj: VIDEO_LICENCES, key, label }) | |
252 | }, | |
253 | ||
254 | deleteLicence: (key: number) => { | |
255 | return this.deleteConstant({ npmName: this.npmName, type: 'licence', obj: VIDEO_LICENCES, key }) | |
256 | } | |
257 | } | |
258 | } | |
259 | ||
260 | private addConstant<T extends string | number> (parameters: { | |
261 | npmName: string | |
262 | type: AlterableVideoConstant | |
263 | obj: VideoConstant | |
264 | key: T | |
265 | label: string | |
266 | }) { | |
267 | const { npmName, type, obj, key, label } = parameters | |
268 | ||
269 | if (obj[key]) { | |
270 | logger.warn('Cannot add %s %s by plugin %s: key already exists.', type, npmName, key) | |
271 | return false | |
272 | } | |
273 | ||
274 | if (!this.updatedVideoConstants[type][npmName]) { | |
275 | this.updatedVideoConstants[type][npmName] = { | |
276 | added: [], | |
277 | deleted: [] | |
278 | } | |
279 | } | |
280 | ||
281 | this.updatedVideoConstants[type][npmName].added.push({ key, label }) | |
282 | obj[key] = label | |
283 | ||
284 | return true | |
285 | } | |
286 | ||
287 | private deleteConstant<T extends string | number> (parameters: { | |
288 | npmName: string | |
289 | type: AlterableVideoConstant | |
290 | obj: VideoConstant | |
291 | key: T | |
292 | }) { | |
293 | const { npmName, type, obj, key } = parameters | |
294 | ||
295 | if (!obj[key]) { | |
296 | logger.warn('Cannot delete %s %s by plugin %s: key does not exist.', type, npmName, key) | |
297 | return false | |
298 | } | |
299 | ||
300 | if (!this.updatedVideoConstants[type][npmName]) { | |
301 | this.updatedVideoConstants[type][npmName] = { | |
302 | added: [], | |
303 | deleted: [] | |
304 | } | |
305 | } | |
306 | ||
307 | this.updatedVideoConstants[type][npmName].deleted.push({ key, label: obj[key] }) | |
308 | delete obj[key] | |
309 | ||
310 | return true | |
311 | } | |
312 | } |