]>
Commit | Line | Data |
---|---|---|
41fb13c3 | 1 | import express from 'express' |
428ccb8b C |
2 | import { logger } from '@server/helpers/logger' |
3 | import { getFormattedObjects } from '@server/helpers/utils' | |
4 | import { listAvailablePluginsFromIndex } from '@server/lib/plugins/plugin-index' | |
5 | import { PluginManager } from '@server/lib/plugins/plugin-manager' | |
ad91e700 | 6 | import { |
e915cde3 | 7 | apiRateLimiter, |
ad91e700 C |
8 | asyncMiddleware, |
9 | authenticate, | |
428ccb8b | 10 | availablePluginsSortValidator, |
ad91e700 | 11 | ensureUserHasRight, |
1333ab1f | 12 | openapiOperationDoc, |
ad91e700 | 13 | paginationValidator, |
428ccb8b | 14 | pluginsSortValidator, |
ad91e700 C |
15 | setDefaultPagination, |
16 | setDefaultSort | |
428ccb8b | 17 | } from '@server/middlewares' |
ad91e700 | 18 | import { |
dba85a1e | 19 | existingPluginValidator, |
b5f919ac | 20 | installOrUpdatePluginValidator, |
6702a1b2 | 21 | listAvailablePluginsValidator, |
ad91e700 C |
22 | listPluginsValidator, |
23 | uninstallPluginValidator, | |
24 | updatePluginSettingsValidator | |
428ccb8b C |
25 | } from '@server/middlewares/validators/plugins' |
26 | import { PluginModel } from '@server/models/server/plugin' | |
428ccb8b | 27 | import { |
4c7e60bc | 28 | HttpStatusCode, |
428ccb8b C |
29 | InstallOrUpdatePlugin, |
30 | ManagePlugin, | |
31 | PeertubePluginIndexList, | |
32 | PublicServerSetting, | |
33 | RegisteredServerSettings, | |
34 | UserRight | |
35 | } from '@shared/models' | |
ad91e700 C |
36 | |
37 | const pluginRouter = express.Router() | |
38 | ||
e915cde3 C |
39 | pluginRouter.use(apiRateLimiter) |
40 | ||
6702a1b2 | 41 | pluginRouter.get('/available', |
1333ab1f | 42 | openapiOperationDoc({ operationId: 'getAvailablePlugins' }), |
6702a1b2 C |
43 | authenticate, |
44 | ensureUserHasRight(UserRight.MANAGE_PLUGINS), | |
45 | listAvailablePluginsValidator, | |
46 | paginationValidator, | |
47 | availablePluginsSortValidator, | |
48 | setDefaultSort, | |
49 | setDefaultPagination, | |
50 | asyncMiddleware(listAvailablePlugins) | |
51 | ) | |
52 | ||
ad91e700 | 53 | pluginRouter.get('/', |
1333ab1f | 54 | openapiOperationDoc({ operationId: 'getPlugins' }), |
ad91e700 C |
55 | authenticate, |
56 | ensureUserHasRight(UserRight.MANAGE_PLUGINS), | |
57 | listPluginsValidator, | |
58 | paginationValidator, | |
59 | pluginsSortValidator, | |
60 | setDefaultSort, | |
61 | setDefaultPagination, | |
62 | asyncMiddleware(listPlugins) | |
63 | ) | |
64 | ||
ba211e73 | 65 | pluginRouter.get('/:npmName/registered-settings', |
ad91e700 C |
66 | authenticate, |
67 | ensureUserHasRight(UserRight.MANAGE_PLUGINS), | |
dba85a1e | 68 | asyncMiddleware(existingPluginValidator), |
ba211e73 | 69 | getPluginRegisteredSettings |
ad91e700 C |
70 | ) |
71 | ||
ba211e73 | 72 | pluginRouter.get('/:npmName/public-settings', |
dba85a1e | 73 | asyncMiddleware(existingPluginValidator), |
ba211e73 | 74 | getPublicPluginSettings |
dba85a1e C |
75 | ) |
76 | ||
77 | pluginRouter.put('/:npmName/settings', | |
ad91e700 C |
78 | authenticate, |
79 | ensureUserHasRight(UserRight.MANAGE_PLUGINS), | |
80 | updatePluginSettingsValidator, | |
dba85a1e | 81 | asyncMiddleware(existingPluginValidator), |
ad91e700 C |
82 | asyncMiddleware(updatePluginSettings) |
83 | ) | |
84 | ||
ba211e73 C |
85 | pluginRouter.get('/:npmName', |
86 | authenticate, | |
87 | ensureUserHasRight(UserRight.MANAGE_PLUGINS), | |
88 | asyncMiddleware(existingPluginValidator), | |
89 | getPlugin | |
90 | ) | |
91 | ||
ad91e700 | 92 | pluginRouter.post('/install', |
1333ab1f | 93 | openapiOperationDoc({ operationId: 'addPlugin' }), |
ad91e700 C |
94 | authenticate, |
95 | ensureUserHasRight(UserRight.MANAGE_PLUGINS), | |
b5f919ac | 96 | installOrUpdatePluginValidator, |
ad91e700 C |
97 | asyncMiddleware(installPlugin) |
98 | ) | |
99 | ||
b5f919ac | 100 | pluginRouter.post('/update', |
1333ab1f | 101 | openapiOperationDoc({ operationId: 'updatePlugin' }), |
b5f919ac C |
102 | authenticate, |
103 | ensureUserHasRight(UserRight.MANAGE_PLUGINS), | |
104 | installOrUpdatePluginValidator, | |
105 | asyncMiddleware(updatePlugin) | |
106 | ) | |
107 | ||
ad91e700 | 108 | pluginRouter.post('/uninstall', |
1333ab1f | 109 | openapiOperationDoc({ operationId: 'uninstallPlugin' }), |
ad91e700 C |
110 | authenticate, |
111 | ensureUserHasRight(UserRight.MANAGE_PLUGINS), | |
112 | uninstallPluginValidator, | |
113 | asyncMiddleware(uninstallPlugin) | |
114 | ) | |
115 | ||
116 | // --------------------------------------------------------------------------- | |
117 | ||
118 | export { | |
119 | pluginRouter | |
120 | } | |
121 | ||
122 | // --------------------------------------------------------------------------- | |
123 | ||
124 | async function listPlugins (req: express.Request, res: express.Response) { | |
6702a1b2 | 125 | const pluginType = req.query.pluginType |
09071200 | 126 | const uninstalled = req.query.uninstalled |
ad91e700 C |
127 | |
128 | const resultList = await PluginModel.listForApi({ | |
6702a1b2 | 129 | pluginType, |
09071200 | 130 | uninstalled, |
ad91e700 C |
131 | start: req.query.start, |
132 | count: req.query.count, | |
133 | sort: req.query.sort | |
134 | }) | |
135 | ||
136 | return res.json(getFormattedObjects(resultList.data, resultList.total)) | |
137 | } | |
138 | ||
dba85a1e C |
139 | function getPlugin (req: express.Request, res: express.Response) { |
140 | const plugin = res.locals.plugin | |
141 | ||
142 | return res.json(plugin.toFormattedJSON()) | |
143 | } | |
144 | ||
ad91e700 | 145 | async function installPlugin (req: express.Request, res: express.Response) { |
b5f919ac | 146 | const body: InstallOrUpdatePlugin = req.body |
ad91e700 | 147 | |
8d2be0ed C |
148 | const fromDisk = !!body.path |
149 | const toInstall = body.npmName || body.path | |
3a1157a6 JL |
150 | |
151 | const pluginVersion = body.pluginVersion && body.npmName | |
152 | ? body.pluginVersion | |
153 | : undefined | |
154 | ||
8d2be0ed | 155 | try { |
841ddf88 | 156 | const plugin = await PluginManager.Instance.install({ toInstall, version: pluginVersion, fromDisk }) |
b5f919ac C |
157 | |
158 | return res.json(plugin.toFormattedJSON()) | |
8d2be0ed C |
159 | } catch (err) { |
160 | logger.warn('Cannot install plugin %s.', toInstall, { err }) | |
76148b27 | 161 | return res.fail({ message: 'Cannot install plugin ' + toInstall }) |
8d2be0ed | 162 | } |
b5f919ac | 163 | } |
ad91e700 | 164 | |
b5f919ac C |
165 | async function updatePlugin (req: express.Request, res: express.Response) { |
166 | const body: InstallOrUpdatePlugin = req.body | |
167 | ||
168 | const fromDisk = !!body.path | |
169 | const toUpdate = body.npmName || body.path | |
170 | try { | |
8280d0c2 | 171 | const plugin = await PluginManager.Instance.update(toUpdate, fromDisk) |
b5f919ac C |
172 | |
173 | return res.json(plugin.toFormattedJSON()) | |
174 | } catch (err) { | |
175 | logger.warn('Cannot update plugin %s.', toUpdate, { err }) | |
76148b27 | 176 | return res.fail({ message: 'Cannot update plugin ' + toUpdate }) |
b5f919ac | 177 | } |
ad91e700 C |
178 | } |
179 | ||
180 | async function uninstallPlugin (req: express.Request, res: express.Response) { | |
181 | const body: ManagePlugin = req.body | |
182 | ||
841ddf88 | 183 | await PluginManager.Instance.uninstall({ npmName: body.npmName }) |
ad91e700 | 184 | |
76148b27 | 185 | return res.status(HttpStatusCode.NO_CONTENT_204).end() |
ad91e700 C |
186 | } |
187 | ||
ba211e73 C |
188 | function getPublicPluginSettings (req: express.Request, res: express.Response) { |
189 | const plugin = res.locals.plugin | |
190 | const registeredSettings = PluginManager.Instance.getRegisteredSettings(req.params.npmName) | |
191 | const publicSettings = plugin.getPublicSettings(registeredSettings) | |
192 | ||
193 | const json: PublicServerSetting = { publicSettings } | |
194 | ||
195 | return res.json(json) | |
196 | } | |
197 | ||
8d2be0ed | 198 | function getPluginRegisteredSettings (req: express.Request, res: express.Response) { |
ba211e73 | 199 | const registeredSettings = PluginManager.Instance.getRegisteredSettings(req.params.npmName) |
ad91e700 | 200 | |
ba211e73 | 201 | const json: RegisteredServerSettings = { registeredSettings } |
09071200 C |
202 | |
203 | return res.json(json) | |
ad91e700 C |
204 | } |
205 | ||
206 | async function updatePluginSettings (req: express.Request, res: express.Response) { | |
207 | const plugin = res.locals.plugin | |
208 | ||
209 | plugin.settings = req.body.settings | |
210 | await plugin.save() | |
211 | ||
a5896799 C |
212 | await PluginManager.Instance.onSettingsChanged(plugin.name, plugin.settings) |
213 | ||
76148b27 | 214 | return res.status(HttpStatusCode.NO_CONTENT_204).end() |
ad91e700 | 215 | } |
6702a1b2 C |
216 | |
217 | async function listAvailablePlugins (req: express.Request, res: express.Response) { | |
218 | const query: PeertubePluginIndexList = req.query | |
219 | ||
220 | const resultList = await listAvailablePluginsFromIndex(query) | |
221 | ||
e0ce715a | 222 | if (!resultList) { |
76148b27 RK |
223 | return res.fail({ |
224 | status: HttpStatusCode.SERVICE_UNAVAILABLE_503, | |
225 | message: 'Plugin index unavailable. Please retry later' | |
226 | }) | |
e0ce715a C |
227 | } |
228 | ||
6702a1b2 C |
229 | return res.json(resultList) |
230 | } |