PeerTube/server/controllers/api/plugins.ts

223 lines
6.2 KiB
TypeScript
Raw Normal View History

2021-08-27 14:32:44 +02:00
import express from 'express'
2021-05-11 12:04:47 +02:00
import { logger } from '@server/helpers/logger'
import { getFormattedObjects } from '@server/helpers/utils'
import { listAvailablePluginsFromIndex } from '@server/lib/plugins/plugin-index'
import { PluginManager } from '@server/lib/plugins/plugin-manager'
import {
asyncMiddleware,
authenticate,
2021-05-11 12:04:47 +02:00
availablePluginsSortValidator,
ensureUserHasRight,
openapiOperationDoc,
paginationValidator,
2021-05-11 12:04:47 +02:00
pluginsSortValidator,
setDefaultPagination,
setDefaultSort
2021-05-11 12:04:47 +02:00
} from '@server/middlewares'
import {
existingPluginValidator,
2019-07-12 11:39:58 +02:00
installOrUpdatePluginValidator,
listAvailablePluginsValidator,
listPluginsValidator,
uninstallPluginValidator,
updatePluginSettingsValidator
2021-05-11 12:04:47 +02:00
} from '@server/middlewares/validators/plugins'
import { PluginModel } from '@server/models/server/plugin'
import {
2021-07-16 14:27:30 +02:00
HttpStatusCode,
2021-05-11 12:04:47 +02:00
InstallOrUpdatePlugin,
ManagePlugin,
PeertubePluginIndexList,
PublicServerSetting,
RegisteredServerSettings,
UserRight
} from '@shared/models'
const pluginRouter = express.Router()
pluginRouter.get('/available',
openapiOperationDoc({ operationId: 'getAvailablePlugins' }),
authenticate,
ensureUserHasRight(UserRight.MANAGE_PLUGINS),
listAvailablePluginsValidator,
paginationValidator,
availablePluginsSortValidator,
setDefaultSort,
setDefaultPagination,
asyncMiddleware(listAvailablePlugins)
)
pluginRouter.get('/',
openapiOperationDoc({ operationId: 'getPlugins' }),
authenticate,
ensureUserHasRight(UserRight.MANAGE_PLUGINS),
listPluginsValidator,
paginationValidator,
pluginsSortValidator,
setDefaultSort,
setDefaultPagination,
asyncMiddleware(listPlugins)
)
2019-07-26 09:35:43 +02:00
pluginRouter.get('/:npmName/registered-settings',
authenticate,
ensureUserHasRight(UserRight.MANAGE_PLUGINS),
asyncMiddleware(existingPluginValidator),
2019-07-26 09:35:43 +02:00
getPluginRegisteredSettings
)
2019-07-26 09:35:43 +02:00
pluginRouter.get('/:npmName/public-settings',
asyncMiddleware(existingPluginValidator),
2019-07-26 09:35:43 +02:00
getPublicPluginSettings
)
pluginRouter.put('/:npmName/settings',
authenticate,
ensureUserHasRight(UserRight.MANAGE_PLUGINS),
updatePluginSettingsValidator,
asyncMiddleware(existingPluginValidator),
asyncMiddleware(updatePluginSettings)
)
2019-07-26 09:35:43 +02:00
pluginRouter.get('/:npmName',
authenticate,
ensureUserHasRight(UserRight.MANAGE_PLUGINS),
asyncMiddleware(existingPluginValidator),
getPlugin
)
pluginRouter.post('/install',
openapiOperationDoc({ operationId: 'addPlugin' }),
authenticate,
ensureUserHasRight(UserRight.MANAGE_PLUGINS),
2019-07-12 11:39:58 +02:00
installOrUpdatePluginValidator,
asyncMiddleware(installPlugin)
)
2019-07-12 11:39:58 +02:00
pluginRouter.post('/update',
openapiOperationDoc({ operationId: 'updatePlugin' }),
2019-07-12 11:39:58 +02:00
authenticate,
ensureUserHasRight(UserRight.MANAGE_PLUGINS),
installOrUpdatePluginValidator,
asyncMiddleware(updatePlugin)
)
pluginRouter.post('/uninstall',
openapiOperationDoc({ operationId: 'uninstallPlugin' }),
authenticate,
ensureUserHasRight(UserRight.MANAGE_PLUGINS),
uninstallPluginValidator,
asyncMiddleware(uninstallPlugin)
)
// ---------------------------------------------------------------------------
export {
pluginRouter
}
// ---------------------------------------------------------------------------
async function listPlugins (req: express.Request, res: express.Response) {
const pluginType = req.query.pluginType
2019-07-19 14:36:04 +02:00
const uninstalled = req.query.uninstalled
const resultList = await PluginModel.listForApi({
pluginType,
2019-07-19 14:36:04 +02:00
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) {
2019-07-12 11:39:58 +02:00
const body: InstallOrUpdatePlugin = req.body
const fromDisk = !!body.path
const toInstall = body.npmName || body.path
try {
2019-07-12 11:39:58 +02:00
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.fail({ message: 'Cannot install plugin ' + toInstall })
}
2019-07-12 11:39:58 +02:00
}
2019-07-12 11:39:58 +02:00
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 {
2021-04-12 10:10:48 +02:00
const plugin = await PluginManager.Instance.update(toUpdate, fromDisk)
2019-07-12 11:39:58 +02:00
return res.json(plugin.toFormattedJSON())
} catch (err) {
logger.warn('Cannot update plugin %s.', toUpdate, { err })
return res.fail({ message: 'Cannot update plugin ' + toUpdate })
2019-07-12 11:39:58 +02:00
}
}
async function uninstallPlugin (req: express.Request, res: express.Response) {
const body: ManagePlugin = req.body
await PluginManager.Instance.uninstall(body.npmName)
return res.status(HttpStatusCode.NO_CONTENT_204).end()
}
2019-07-26 09:35:43 +02:00
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) {
2019-07-26 09:35:43 +02:00
const registeredSettings = PluginManager.Instance.getRegisteredSettings(req.params.npmName)
2019-07-26 09:35:43 +02:00
const json: RegisteredServerSettings = { registeredSettings }
2019-07-19 14:36:04 +02:00
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()
2020-04-30 09:28:39 +02:00
await PluginManager.Instance.onSettingsChanged(plugin.name, plugin.settings)
return res.status(HttpStatusCode.NO_CONTENT_204).end()
}
async function listAvailablePlugins (req: express.Request, res: express.Response) {
const query: PeertubePluginIndexList = req.query
const resultList = await listAvailablePluginsFromIndex(query)
2019-07-16 14:52:24 +02:00
if (!resultList) {
return res.fail({
status: HttpStatusCode.SERVICE_UNAVAILABLE_503,
message: 'Plugin index unavailable. Please retry later'
})
2019-07-16 14:52:24 +02:00
}
return res.json(resultList)
}