Fix filters on playlists

[github/Chocobozzz/PeerTube.git] / server / middlewares / validators / plugins.ts

diff --git a/server/middlewares/validators/plugins.ts b/server/middlewares/validators/plugins.ts
index 1083e0afae83677c9bbd9122f674d6038e3ac687..64bef26480f57f243ffd6daffaea28ed90569713 100644 (file)
--- a/server/middlewares/validators/plugins.ts
+++ b/server/middlewares/validators/plugins.ts
@@ -1,38 +1,52 @@
-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 { isNpmPluginNameValid, isPluginNameValid, isPluginTypeValid, isPluginVersionValid } from '../../helpers/custom-validators/plugins'
-import { PluginManager } from '../../lib/plugins/plugin-manager'
-import { isBooleanValid, isSafePath, toBooleanOrNull, exists, toIntOrNull } from '../../helpers/custom-validators/misc'
-import { PluginModel } from '../../models/server/plugin'
-import { InstallOrUpdatePlugin } from '../../../shared/models/plugins/install-plugin.model'
+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,
+  isPluginStableOrUnstableVersionValid,
+  isPluginTypeValid
+} from '../../helpers/custom-validators/plugins'
 import { CONFIG } from '../../initializers/config'
-import { HttpStatusCode } from '../../../shared/core-utils/miscs/http-error-codes'
+import { PluginManager } from '../../lib/plugins/plugin-manager'
+import { PluginModel } from '../../models/server/plugin'
+import { areValidationErrors } from './shared'
 
 const getPluginValidator = (pluginType: PluginType, withVersion = true) => {
   const validators: (ValidationChain | express.Handler)[] = [
-    param('pluginName').custom(isPluginNameValid).withMessage('Should have a valid plugin name')
+    param('pluginName')
+      .custom(isPluginNameValid)
   ]
 
   if (withVersion) {
     validators.push(
-      param('pluginVersion').custom(isPluginVersionValid).withMessage('Should have a valid plugin version')
+      param('pluginVersion')
+        .custom(isPluginStableOrUnstableVersionValid)
     )
   }
 
   return validators.concat([
     (req: express.Request, res: express.Response, next: express.NextFunction) => {
-      logger.debug('Checking getPluginValidator 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) return res.sendStatus(HttpStatusCode.NOT_FOUND_404)
-      if (withVersion && plugin.version !== req.params.pluginVersion) return res.sendStatus(HttpStatusCode.NOT_FOUND_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
 
@@ -42,18 +56,27 @@ const getPluginValidator = (pluginType: PluginType, withVersion = true) => {
 }
 
 const getExternalAuthValidator = [
-  param('authName').custom(exists).withMessage('Should have a valid auth name'),
+  param('authName')
+    .custom(exists),
 
   (req: express.Request, res: express.Response, next: express.NextFunction) => {
-    logger.debug('Checking getExternalAuthValidator parameters', { parameters: req.params })
-
     if (areValidationErrors(req, res)) return
 
     const plugin = res.locals.registeredPlugin
-    if (!plugin.registerHelpers) return res.sendStatus(HttpStatusCode.NOT_FOUND_404)
+    if (!plugin.registerHelpers) {
+      return res.fail({
+        status: HttpStatusCode.NOT_FOUND_404,
+        message: 'No registered helpers were found for this plugin'
+      })
+    }
 
     const externalAuth = plugin.registerHelpers.getExternalAuths().find(a => a.authName === req.params.authName)
-    if (!externalAuth) return res.sendStatus(HttpStatusCode.NOT_FOUND_404)
+    if (!externalAuth) {
+      return res.fail({
+        status: HttpStatusCode.NOT_FOUND_404,
+        message: 'No external auths were found for this plugin'
+      })
+    }
 
     res.locals.externalAuth = externalAuth
 
@@ -62,11 +85,10 @@ const getExternalAuthValidator = [
 ]
 
 const pluginStaticDirectoryValidator = [
-  param('staticEndpoint').custom(isSafePath).withMessage('Should have a valid static endpoint'),
+  param('staticEndpoint')
+    .custom(isSafePath),
 
   (req: express.Request, res: express.Response, next: express.NextFunction) => {
-    logger.debug('Checking pluginStaticDirectoryValidator parameters', { parameters: req.params })
-
     if (areValidationErrors(req, res)) return
 
     return next()
@@ -77,15 +99,13 @@ const listPluginsValidator = [
   query('pluginType')
     .optional()
     .customSanitizer(toIntOrNull)
-    .custom(isPluginTypeValid).withMessage('Should have a valid plugin type'),
+    .custom(isPluginTypeValid),
   query('uninstalled')
     .optional()
     .customSanitizer(toBooleanOrNull)
-    .custom(isBooleanValid).withMessage('Should have a valid uninstalled attribute'),
+    .custom(isBooleanValid),
 
   (req: express.Request, res: express.Response, next: express.NextFunction) => {
-    logger.debug('Checking listPluginsValidator parameters', { parameters: req.query })
-
     if (areValidationErrors(req, res)) return
 
     return next()
@@ -95,21 +115,23 @@ const listPluginsValidator = [
 const installOrUpdatePluginValidator = [
   body('npmName')
     .optional()
-    .custom(isNpmPluginNameValid).withMessage('Should have a valid npm name'),
+    .custom(isNpmPluginNameValid),
+  body('pluginVersion')
+    .optional()
+    .custom(isPluginStableOrUnstableVersionValid),
   body('path')
     .optional()
-    .custom(isSafePath).withMessage('Should have a valid safe path'),
+    .custom(isSafePath),
 
   (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(HttpStatusCode.BAD_REQUEST_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()
@@ -117,11 +139,10 @@ const installOrUpdatePluginValidator = [
 ]
 
 const uninstallPluginValidator = [
-  body('npmName').custom(isNpmPluginNameValid).withMessage('Should have a valid npm name'),
+  body('npmName')
+    .custom(isNpmPluginNameValid),
 
   (req: express.Request, res: express.Response, next: express.NextFunction) => {
-    logger.debug('Checking uninstallPluginValidator parameters', { parameters: req.body })
-
     if (areValidationErrors(req, res)) return
 
     return next()
@@ -129,32 +150,30 @@ const uninstallPluginValidator = [
 ]
 
 const existingPluginValidator = [
-  param('npmName').custom(isNpmPluginNameValid).withMessage('Should have a valid plugin name'),
+  param('npmName')
+    .custom(isNpmPluginNameValid),
 
   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(HttpStatusCode.NOT_FOUND_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()
   }
 ]
 
 const updatePluginSettingsValidator = [
-  body('settings').exists().withMessage('Should have settings'),
+  body('settings')
+    .exists(),
 
   (req: express.Request, res: express.Response, next: express.NextFunction) => {
-    logger.debug('Checking enabledPluginValidator parameters', { parameters: req.body })
-
     if (areValidationErrors(req, res)) return
 
     return next()
@@ -164,24 +183,20 @@ const updatePluginSettingsValidator = [
 const listAvailablePluginsValidator = [
   query('search')
     .optional()
-    .exists().withMessage('Should have a valid search'),
+    .exists(),
   query('pluginType')
     .optional()
     .customSanitizer(toIntOrNull)
-    .custom(isPluginTypeValid).withMessage('Should have a valid plugin type'),
+    .custom(isPluginTypeValid),
   query('currentPeerTubeEngine')
     .optional()
-    .custom(isPluginVersionValid).withMessage('Should have a valid current peertube engine'),
+    .custom(isPluginStableOrUnstableVersionValid),
 
   (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(HttpStatusCode.BAD_REQUEST_400)
-                .json({ error: 'Plugin index is not enabled' })
-                .end()
+      return res.fail({ message: 'Plugin index is not enabled' })
     }
 
     return next()