Merge branch 'release/3.2.0' into develop

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

diff --git a/server/middlewares/validators/plugins.ts b/server/middlewares/validators/plugins.ts
index 8103ec7d327e392381a9886ceb882e9db5f37ed2..2c47ec5bbd03aef78f0a852c98cae228d2f7357a 100644 (file)
--- a/server/middlewares/validators/plugins.ts
+++ b/server/middlewares/validators/plugins.ts
@@ -1,44 +1,86 @@
 import * as express from 'express'
-import { body, param, query } from 'express-validator/check'
-import { logger } from '../../helpers/logger'
-import { areValidationErrors } from './utils'
+import { body, param, query, ValidationChain } from 'express-validator'
+import { HttpStatusCode } from '../../../shared/core-utils/miscs/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 } 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 { areValidationErrors } from './utils'
 
-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')
+  ]
+
+  if (withVersion) {
+    validators.push(
+      param('pluginVersion').custom(isPluginVersionValid).withMessage('Should have a valid plugin version')
+    )
+  }
+
+  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)
+
+      res.locals.registeredPlugin = plugin
+
+      return next()
+    }
+  ])
+}
+
+const getExternalAuthValidator = [
+  param('authName').custom(exists).withMessage('Should have a valid auth name'),
 
   (req: express.Request, res: express.Response, next: express.NextFunction) => {
-    logger.debug('Checking servePluginStaticDirectory parameters', { parameters: req.params })
+    logger.debug('Checking getExternalAuthValidator parameters', { parameters: req.params })
 
     if (areValidationErrors(req, res)) return
 
-    const npmName = PluginModel.buildNpmName(req.params.pluginName, pluginType)
-    const plugin = PluginManager.Instance.getRegisteredPluginOrTheme(npmName)
+    const plugin = res.locals.registeredPlugin
+    if (!plugin.registerHelpers) return res.sendStatus(HttpStatusCode.NOT_FOUND_404)
 
-    if (!plugin || plugin.version !== req.params.pluginVersion) {
-      return res.sendStatus(404)
-    }
+    const externalAuth = plugin.registerHelpers.getExternalAuths().find(a => a.authName === req.params.authName)
+    if (!externalAuth) return res.sendStatus(HttpStatusCode.NOT_FOUND_404)
+
+    res.locals.externalAuth = externalAuth
+
+    return next()
+  }
+]
+
+const pluginStaticDirectoryValidator = [
+  param('staticEndpoint').custom(isSafePath).withMessage('Should have a valid static endpoint'),
 
-    res.locals.registeredPlugin = plugin
+  (req: express.Request, res: express.Response, next: express.NextFunction) => {
+    logger.debug('Checking pluginStaticDirectoryValidator parameters', { parameters: req.params })
+
+    if (areValidationErrors(req, res)) return
 
     return next()
   }
 ]
 
 const listPluginsValidator = [
-  query('type')
+  query('pluginType')
     .optional()
+    .customSanitizer(toIntOrNull)
     .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) => {
@@ -65,9 +107,8 @@ const installOrUpdatePluginValidator = [
 
     const body: InstallOrUpdatePlugin = req.body
     if (!body.path && !body.npmName) {
-      return res.status(400)
+      return res.status(HttpStatusCode.BAD_REQUEST_400)
                 .json({ error: 'Should have either a npmName or a path' })
-                .end()
     }
 
     return next()
@@ -87,7 +128,7 @@ const uninstallPluginValidator = [
 ]
 
 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 })
@@ -96,9 +137,8 @@ const existingPluginValidator = [
 
     const plugin = await PluginModel.loadByNpmName(req.params.npmName)
     if (!plugin) {
-      return res.status(404)
-         .json({ error: 'Plugin not found' })
-         .end()
+      return res.status(HttpStatusCode.NOT_FOUND_404)
+                .json({ error: 'Plugin not found' })
     }
 
     res.locals.plugin = plugin
@@ -119,13 +159,43 @@ const updatePluginSettingsValidator = [
   }
 ]
 
+const listAvailablePluginsValidator = [
+  query('search')
+    .optional()
+    .exists().withMessage('Should have a valid search'),
+  query('pluginType')
+    .optional()
+    .customSanitizer(toIntOrNull)
+    .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(HttpStatusCode.BAD_REQUEST_400)
+                .json({ error: 'Plugin index is not enabled' })
+                .end()
+    }
+
+    return next()
+  }
+]
+
 // ---------------------------------------------------------------------------
 
 export {
-  servePluginStaticDirectoryValidator,
+  pluginStaticDirectoryValidator,
+  getPluginValidator,
   updatePluginSettingsValidator,
   uninstallPluginValidator,
+  listAvailablePluginsValidator,
   existingPluginValidator,
   installOrUpdatePluginValidator,
-  listPluginsValidator
+  listPluginsValidator,
+  getExternalAuthValidator
 }