123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159 |
- import * as express from 'express'
- import { body, param, query } from 'express-validator'
- import { logger } from '../../helpers/logger'
- import { areValidationErrors } from './utils'
- import { isNpmPluginNameValid, isPluginNameValid, isPluginTypeValid, isPluginVersionValid } from '../../helpers/custom-validators/plugins'
- import { PluginManager } from '../../lib/plugins/plugin-manager'
- import { isBooleanValid, isSafePath, toBooleanOrNull } from '../../helpers/custom-validators/misc'
- import { PluginModel } from '../../models/server/plugin'
- import { InstallOrUpdatePlugin } from '../../../shared/models/plugins/install-plugin.model'
- import { PluginType } from '../../../shared/models/plugins/plugin.type'
- import { CONFIG } from '../../initializers/config'
- const servePluginStaticDirectoryValidator = (pluginType: PluginType) => [
- param('pluginName').custom(isPluginNameValid).withMessage('Should have a valid plugin name'),
- param('pluginVersion').custom(isPluginVersionValid).withMessage('Should have a valid plugin version'),
- param('staticEndpoint').custom(isSafePath).withMessage('Should have a valid static endpoint'),
- (req: express.Request, res: express.Response, next: express.NextFunction) => {
- logger.debug('Checking servePluginStaticDirectory parameters', { parameters: req.params })
- if (areValidationErrors(req, res)) return
- const npmName = PluginModel.buildNpmName(req.params.pluginName, pluginType)
- const plugin = PluginManager.Instance.getRegisteredPluginOrTheme(npmName)
- if (!plugin || plugin.version !== req.params.pluginVersion) {
- return res.sendStatus(404)
- }
- res.locals.registeredPlugin = plugin
- return next()
- }
- ]
- const listPluginsValidator = [
- query('pluginType')
- .optional()
- .custom(isPluginTypeValid).withMessage('Should have a valid plugin type'),
- query('uninstalled')
- .optional()
- .customSanitizer(toBooleanOrNull)
- .custom(isBooleanValid).withMessage('Should have a valid uninstalled attribute'),
- (req: express.Request, res: express.Response, next: express.NextFunction) => {
- logger.debug('Checking listPluginsValidator parameters', { parameters: req.query })
- if (areValidationErrors(req, res)) return
- return next()
- }
- ]
- const installOrUpdatePluginValidator = [
- body('npmName')
- .optional()
- .custom(isNpmPluginNameValid).withMessage('Should have a valid npm name'),
- body('path')
- .optional()
- .custom(isSafePath).withMessage('Should have a valid safe path'),
- (req: express.Request, res: express.Response, next: express.NextFunction) => {
- logger.debug('Checking installOrUpdatePluginValidator parameters', { parameters: req.body })
- if (areValidationErrors(req, res)) return
- const body: InstallOrUpdatePlugin = req.body
- if (!body.path && !body.npmName) {
- return res.status(400)
- .json({ error: 'Should have either a npmName or a path' })
- .end()
- }
- return next()
- }
- ]
- const uninstallPluginValidator = [
- body('npmName').custom(isNpmPluginNameValid).withMessage('Should have a valid npm name'),
- (req: express.Request, res: express.Response, next: express.NextFunction) => {
- logger.debug('Checking uninstallPluginValidator parameters', { parameters: req.body })
- if (areValidationErrors(req, res)) return
- return next()
- }
- ]
- const existingPluginValidator = [
- param('npmName').custom(isNpmPluginNameValid).withMessage('Should have a valid plugin name'),
- async (req: express.Request, res: express.Response, next: express.NextFunction) => {
- logger.debug('Checking enabledPluginValidator parameters', { parameters: req.params })
- if (areValidationErrors(req, res)) return
- const plugin = await PluginModel.loadByNpmName(req.params.npmName)
- if (!plugin) {
- return res.status(404)
- .json({ error: 'Plugin not found' })
- .end()
- }
- res.locals.plugin = plugin
- return next()
- }
- ]
- const updatePluginSettingsValidator = [
- body('settings').exists().withMessage('Should have settings'),
- (req: express.Request, res: express.Response, next: express.NextFunction) => {
- logger.debug('Checking enabledPluginValidator parameters', { parameters: req.body })
- if (areValidationErrors(req, res)) return
- return next()
- }
- ]
- const listAvailablePluginsValidator = [
- query('search')
- .optional()
- .exists().withMessage('Should have a valid search'),
- query('pluginType')
- .optional()
- .custom(isPluginTypeValid).withMessage('Should have a valid plugin type'),
- query('currentPeerTubeEngine')
- .optional()
- .custom(isPluginVersionValid).withMessage('Should have a valid current peertube engine'),
- (req: express.Request, res: express.Response, next: express.NextFunction) => {
- logger.debug('Checking enabledPluginValidator parameters', { parameters: req.query })
- if (areValidationErrors(req, res)) return
- if (CONFIG.PLUGINS.INDEX.ENABLED === false) {
- return res.status(400)
- .json({ error: 'Plugin index is not enabled' })
- .end()
- }
- return next()
- }
- ]
- // ---------------------------------------------------------------------------
- export {
- servePluginStaticDirectoryValidator,
- updatePluginSettingsValidator,
- uninstallPluginValidator,
- listAvailablePluginsValidator,
- existingPluginValidator,
- installOrUpdatePluginValidator,
- listPluginsValidator
- }
|