123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212 |
- import * as express from 'express'
- import { getFormattedObjects } from '../../helpers/utils'
- import {
- asyncMiddleware,
- authenticate,
- ensureUserHasRight,
- paginationValidator,
- setDefaultPagination,
- setDefaultSort
- } from '../../middlewares'
- 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
- } from '../../middlewares/validators/plugins'
- 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),
- listPluginsValidator,
- paginationValidator,
- pluginsSortValidator,
- setDefaultSort,
- setDefaultPagination,
- asyncMiddleware(listPlugins)
- )
- pluginRouter.get('/:npmName/registered-settings',
- authenticate,
- ensureUserHasRight(UserRight.MANAGE_PLUGINS),
- asyncMiddleware(existingPluginValidator),
- getPluginRegisteredSettings
- )
- pluginRouter.get('/:npmName/public-settings',
- asyncMiddleware(existingPluginValidator),
- getPublicPluginSettings
- )
- pluginRouter.put('/:npmName/settings',
- authenticate,
- ensureUserHasRight(UserRight.MANAGE_PLUGINS),
- updatePluginSettingsValidator,
- asyncMiddleware(existingPluginValidator),
- asyncMiddleware(updatePluginSettings)
- )
- pluginRouter.get('/:npmName',
- authenticate,
- ensureUserHasRight(UserRight.MANAGE_PLUGINS),
- asyncMiddleware(existingPluginValidator),
- getPlugin
- )
- pluginRouter.post('/install',
- authenticate,
- ensureUserHasRight(UserRight.MANAGE_PLUGINS),
- installOrUpdatePluginValidator,
- asyncMiddleware(installPlugin)
- )
- pluginRouter.post('/update',
- authenticate,
- ensureUserHasRight(UserRight.MANAGE_PLUGINS),
- installOrUpdatePluginValidator,
- asyncMiddleware(updatePlugin)
- )
- pluginRouter.post('/uninstall',
- authenticate,
- ensureUserHasRight(UserRight.MANAGE_PLUGINS),
- uninstallPluginValidator,
- asyncMiddleware(uninstallPlugin)
- )
- // ---------------------------------------------------------------------------
- export {
- pluginRouter
- }
- // ---------------------------------------------------------------------------
- async function listPlugins (req: express.Request, res: express.Response) {
- const pluginType = req.query.pluginType
- const uninstalled = req.query.uninstalled
- const resultList = await PluginModel.listForApi({
- pluginType,
- uninstalled,
- start: req.query.start,
- count: req.query.count,
- sort: req.query.sort
- })
- return res.json(getFormattedObjects(resultList.data, resultList.total))
- }
- function getPlugin (req: express.Request, res: express.Response) {
- const plugin = res.locals.plugin
- return res.json(plugin.toFormattedJSON())
- }
- async function installPlugin (req: express.Request, res: express.Response) {
- const body: InstallOrUpdatePlugin = req.body
- const fromDisk = !!body.path
- const toInstall = body.npmName || body.path
- try {
- const plugin = await PluginManager.Instance.install(toInstall, undefined, fromDisk)
- return res.json(plugin.toFormattedJSON())
- } catch (err) {
- logger.warn('Cannot install plugin %s.', toInstall, { err })
- return res.sendStatus(HttpStatusCode.BAD_REQUEST_400)
- }
- }
- async function updatePlugin (req: express.Request, res: express.Response) {
- const body: InstallOrUpdatePlugin = req.body
- const fromDisk = !!body.path
- const toUpdate = body.npmName || body.path
- try {
- const plugin = await PluginManager.Instance.update(toUpdate, undefined, fromDisk)
- return res.json(plugin.toFormattedJSON())
- } catch (err) {
- logger.warn('Cannot update plugin %s.', toUpdate, { err })
- return res.sendStatus(HttpStatusCode.BAD_REQUEST_400)
- }
- }
- async function uninstallPlugin (req: express.Request, res: express.Response) {
- const body: ManagePlugin = req.body
- await PluginManager.Instance.uninstall(body.npmName)
- 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 registeredSettings = PluginManager.Instance.getRegisteredSettings(req.params.npmName)
- const json: RegisteredServerSettings = { registeredSettings }
- return res.json(json)
- }
- async function updatePluginSettings (req: express.Request, res: express.Response) {
- const plugin = res.locals.plugin
- plugin.settings = req.body.settings
- await plugin.save()
- 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)
- }
|