X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fcontrollers%2Fapi%2Fplugins.ts;h=1c0b5edb1fdd02df278e33b696ca353a6298630e;hb=3da68f0a781ebd893521e2e6fa200280c92ae815;hp=14675fdf30452e25681a8e5da69cc5f5c680505e;hpb=b5f919ac8eb2a1c20e26582fdfd377d687710d8f;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/controllers/api/plugins.ts b/server/controllers/api/plugins.ts index 14675fdf3..1c0b5edb1 100644 --- a/server/controllers/api/plugins.ts +++ b/server/controllers/api/plugins.ts @@ -8,12 +8,13 @@ import { setDefaultPagination, setDefaultSort } from '../../middlewares' -import { pluginsSortValidator } from '../../middlewares/validators' +import { availablePluginsSortValidator, pluginsSortValidator } from '../../middlewares/validators' import { PluginModel } from '../../models/server/plugin' import { UserRight } from '../../../shared/models/users' import { existingPluginValidator, installOrUpdatePluginValidator, + listAvailablePluginsValidator, listPluginsValidator, uninstallPluginValidator, updatePluginSettingsValidator @@ -22,9 +23,25 @@ import { PluginManager } from '../../lib/plugins/plugin-manager' import { InstallOrUpdatePlugin } from '../../../shared/models/plugins/install-plugin.model' import { ManagePlugin } from '../../../shared/models/plugins/manage-plugin.model' import { logger } from '../../helpers/logger' +import { listAvailablePluginsFromIndex } from '../../lib/plugins/plugin-index' +import { PeertubePluginIndexList } from '../../../shared/models/plugins/peertube-plugin-index-list.model' +import { RegisteredServerSettings } from '../../../shared/models/plugins/register-server-setting.model' +import { PublicServerSetting } from '../../../shared/models/plugins/public-server.setting' +import { HttpStatusCode } from '../../../shared/core-utils/miscs/http-error-codes' const pluginRouter = express.Router() +pluginRouter.get('/available', + authenticate, + ensureUserHasRight(UserRight.MANAGE_PLUGINS), + listAvailablePluginsValidator, + paginationValidator, + availablePluginsSortValidator, + setDefaultSort, + setDefaultPagination, + asyncMiddleware(listAvailablePlugins) +) + pluginRouter.get('/', authenticate, ensureUserHasRight(UserRight.MANAGE_PLUGINS), @@ -36,18 +53,16 @@ pluginRouter.get('/', asyncMiddleware(listPlugins) ) -pluginRouter.get('/:npmName', +pluginRouter.get('/:npmName/registered-settings', authenticate, ensureUserHasRight(UserRight.MANAGE_PLUGINS), asyncMiddleware(existingPluginValidator), - getPlugin + getPluginRegisteredSettings ) -pluginRouter.get('/:npmName/registered-settings', - authenticate, - ensureUserHasRight(UserRight.MANAGE_PLUGINS), +pluginRouter.get('/:npmName/public-settings', asyncMiddleware(existingPluginValidator), - getPluginRegisteredSettings + getPublicPluginSettings ) pluginRouter.put('/:npmName/settings', @@ -58,6 +73,13 @@ pluginRouter.put('/:npmName/settings', asyncMiddleware(updatePluginSettings) ) +pluginRouter.get('/:npmName', + authenticate, + ensureUserHasRight(UserRight.MANAGE_PLUGINS), + asyncMiddleware(existingPluginValidator), + getPlugin +) + pluginRouter.post('/install', authenticate, ensureUserHasRight(UserRight.MANAGE_PLUGINS), @@ -88,10 +110,12 @@ export { // --------------------------------------------------------------------------- async function listPlugins (req: express.Request, res: express.Response) { - const type = req.query.type + const pluginType = req.query.pluginType + const uninstalled = req.query.uninstalled const resultList = await PluginModel.listForApi({ - type, + pluginType, + uninstalled, start: req.query.start, count: req.query.count, sort: req.query.sort @@ -117,7 +141,7 @@ async function installPlugin (req: express.Request, res: express.Response) { return res.json(plugin.toFormattedJSON()) } catch (err) { logger.warn('Cannot install plugin %s.', toInstall, { err }) - return res.sendStatus(400) + return res.sendStatus(HttpStatusCode.BAD_REQUEST_400) } } @@ -132,7 +156,7 @@ async function updatePlugin (req: express.Request, res: express.Response) { return res.json(plugin.toFormattedJSON()) } catch (err) { logger.warn('Cannot update plugin %s.', toUpdate, { err }) - return res.sendStatus(400) + return res.sendStatus(HttpStatusCode.BAD_REQUEST_400) } } @@ -141,15 +165,25 @@ async function uninstallPlugin (req: express.Request, res: express.Response) { await PluginManager.Instance.uninstall(body.npmName) - return res.sendStatus(204) + return res.sendStatus(HttpStatusCode.NO_CONTENT_204) +} + +function getPublicPluginSettings (req: express.Request, res: express.Response) { + const plugin = res.locals.plugin + const registeredSettings = PluginManager.Instance.getRegisteredSettings(req.params.npmName) + const publicSettings = plugin.getPublicSettings(registeredSettings) + + const json: PublicServerSetting = { publicSettings } + + return res.json(json) } function getPluginRegisteredSettings (req: express.Request, res: express.Response) { - const settings = PluginManager.Instance.getRegisteredSettings(req.params.npmName) + const registeredSettings = PluginManager.Instance.getRegisteredSettings(req.params.npmName) - return res.json({ - settings - }) + const json: RegisteredServerSettings = { registeredSettings } + + return res.json(json) } async function updatePluginSettings (req: express.Request, res: express.Response) { @@ -158,5 +192,21 @@ async function updatePluginSettings (req: express.Request, res: express.Response plugin.settings = req.body.settings await plugin.save() - return res.sendStatus(204) + await PluginManager.Instance.onSettingsChanged(plugin.name, plugin.settings) + + return res.sendStatus(HttpStatusCode.NO_CONTENT_204) +} + +async function listAvailablePlugins (req: express.Request, res: express.Response) { + const query: PeertubePluginIndexList = req.query + + const resultList = await listAvailablePluginsFromIndex(query) + + if (!resultList) { + return res.status(HttpStatusCode.SERVICE_UNAVAILABLE_503) + .json({ error: 'Plugin index unavailable. Please retry later' }) + .end() + } + + return res.json(resultList) }