-import * as express from 'express'
+import express from 'express'
import { body, param, query, ValidationChain } from 'express-validator'
-import { logger } from '../../helpers/logger'
-import { areValidationErrors } from './utils'
+import { HttpStatusCode } from '../../../shared/models/http/http-error-codes'
+import { PluginType } from '../../../shared/models/plugins/plugin.type'
+import { InstallOrUpdatePlugin } from '../../../shared/models/plugins/server/api/install-plugin.model'
+import { exists, isBooleanValid, isSafePath, toBooleanOrNull, toIntOrNull } from '../../helpers/custom-validators/misc'
import { isNpmPluginNameValid, isPluginNameValid, isPluginTypeValid, isPluginVersionValid } from '../../helpers/custom-validators/plugins'
+import { logger } from '../../helpers/logger'
+import { CONFIG } from '../../initializers/config'
import { PluginManager } from '../../lib/plugins/plugin-manager'
-import { isBooleanValid, isSafePath, toBooleanOrNull, exists } 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'
+import { areValidationErrors } from './shared'
const getPluginValidator = (pluginType: PluginType, withVersion = true) => {
const validators: (ValidationChain | express.Handler)[] = [
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)
+ if (!plugin) {
+ return res.fail({
+ status: HttpStatusCode.NOT_FOUND_404,
+ message: 'No plugin found named ' + npmName
+ })
+ }
+ if (withVersion && plugin.version !== req.params.pluginVersion) {
+ return res.fail({
+ status: HttpStatusCode.NOT_FOUND_404,
+ message: 'No plugin found named ' + npmName + ' with version ' + req.params.pluginVersion
+ })
+ }
res.locals.registeredPlugin = plugin
if (areValidationErrors(req, res)) return
const plugin = res.locals.registeredPlugin
- if (!plugin.registerHelpersStore) return res.sendStatus(404)
+ if (!plugin.registerHelpers) {
+ return res.fail({
+ status: HttpStatusCode.NOT_FOUND_404,
+ message: 'No registered helpers were found for this plugin'
+ })
+ }
- const externalAuth = plugin.registerHelpersStore.getExternalAuths().find(a => a.authName === req.params.authName)
- if (!externalAuth) return res.sendStatus(404)
+ const externalAuth = plugin.registerHelpers.getExternalAuths().find(a => a.authName === req.params.authName)
+ if (!externalAuth) {
+ return res.fail({
+ status: HttpStatusCode.NOT_FOUND_404,
+ message: 'No external auths were found for this plugin'
+ })
+ }
res.locals.externalAuth = externalAuth
const listPluginsValidator = [
query('pluginType')
.optional()
+ .customSanitizer(toIntOrNull)
.custom(isPluginTypeValid).withMessage('Should have a valid plugin type'),
query('uninstalled')
.optional()
body('npmName')
.optional()
.custom(isNpmPluginNameValid).withMessage('Should have a valid npm name'),
+ body('pluginVersion')
+ .optional()
+ .custom(isPluginVersionValid).withMessage('Should have a valid plugin version'),
body('path')
.optional()
.custom(isSafePath).withMessage('Should have a valid safe path'),
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 res.fail({ message: 'Should have either a npmName or a path' })
+ }
+ if (body.pluginVersion && !body.npmName) {
+ return res.fail({ message: 'Should have a npmName when specifying a pluginVersion' })
}
return next()
const plugin = await PluginModel.loadByNpmName(req.params.npmName)
if (!plugin) {
- return res.status(404)
- .json({ error: 'Plugin not found' })
- .end()
+ return res.fail({
+ status: HttpStatusCode.NOT_FOUND_404,
+ message: 'Plugin not found'
+ })
}
res.locals.plugin = plugin
-
return next()
}
]
.exists().withMessage('Should have a valid search'),
query('pluginType')
.optional()
+ .customSanitizer(toIntOrNull)
.custom(isPluginTypeValid).withMessage('Should have a valid plugin type'),
query('currentPeerTubeEngine')
.optional()
if (areValidationErrors(req, res)) return
if (CONFIG.PLUGINS.INDEX.ENABLED === false) {
- return res.status(400)
- .json({ error: 'Plugin index is not enabled' })
- .end()
+ return res.fail({ message: 'Plugin index is not enabled' })
}
return next()