import * as express from 'express'
-import { body, param, query } from 'express-validator/check'
+import { body, param, query, ValidationChain } 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 } from '../../helpers/custom-validators/misc'
+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'),
+const getPluginValidator = (pluginType: PluginType, withVersion = true) => {
+ const validators: (ValidationChain | express.Handler)[] = [
+ param('pluginName').custom(isPluginNameValid).withMessage('Should have a valid plugin name')
+ ]
- (req: express.Request, res: express.Response, next: express.NextFunction) => {
- logger.debug('Checking servePluginStaticDirectory parameters', { parameters: req.params })
+ if (withVersion) {
+ validators.push(
+ param('pluginVersion').custom(isPluginVersionValid).withMessage('Should have a valid plugin version')
+ )
+ }
- if (areValidationErrors(req, res)) return
+ return validators.concat([
+ (req: express.Request, res: express.Response, next: express.NextFunction) => {
+ logger.debug('Checking getPluginValidator parameters', { parameters: req.params })
- const npmName = PluginModel.buildNpmName(req.params.pluginName, pluginType)
- const plugin = PluginManager.Instance.getRegisteredPluginOrTheme(npmName)
+ if (areValidationErrors(req, res)) return
- if (!plugin || plugin.version !== req.params.pluginVersion) {
- return res.sendStatus(404)
+ const npmName = PluginModel.buildNpmName(req.params.pluginName, pluginType)
+ const plugin = PluginManager.Instance.getRegisteredPluginOrTheme(npmName)
+
+ if (!plugin) return res.sendStatus(404)
+ if (withVersion && plugin.version !== req.params.pluginVersion) return res.sendStatus(404)
+
+ res.locals.registeredPlugin = plugin
+
+ return next()
}
+ ])
+}
- res.locals.registeredPlugin = plugin
+const pluginStaticDirectoryValidator = [
+ param('staticEndpoint').custom(isSafePath).withMessage('Should have a valid static endpoint'),
+
+ (req: express.Request, res: express.Response, next: express.NextFunction) => {
+ logger.debug('Checking pluginStaticDirectoryValidator parameters', { parameters: req.params })
+
+ if (areValidationErrors(req, res)) return
return next()
}
.custom(isPluginTypeValid).withMessage('Should have a valid plugin type'),
query('uninstalled')
.optional()
- .toBoolean()
+ .customSanitizer(toBooleanOrNull)
.custom(isBooleanValid).withMessage('Should have a valid uninstalled attribute'),
(req: express.Request, res: express.Response, next: express.NextFunction) => {
]
const existingPluginValidator = [
- param('npmName').custom(isPluginNameValid).withMessage('Should have a valid plugin name'),
+ 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 })
]
const listAvailablePluginsValidator = [
- query('sort')
- .optional()
- .exists().withMessage('Should have a valid sort'),
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 })
// ---------------------------------------------------------------------------
export {
- servePluginStaticDirectoryValidator,
+ pluginStaticDirectoryValidator,
+ getPluginValidator,
updatePluginSettingsValidator,
uninstallPluginValidator,
listAvailablePluginsValidator,