Add server hooks

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

diff --git a/server/middlewares/validators/plugins.ts b/server/middlewares/validators/plugins.ts
index 265ac7c17b0f84f1868328ad29b8e1897a8591f9..8cb3153aa1cd96e9f7e0a802814129210e3ef4e4 100644 (file)
--- a/server/middlewares/validators/plugins.ts
+++ b/server/middlewares/validators/plugins.ts
@@ -1,13 +1,16 @@
 import * as express from 'express'
-import { param, query, body } from 'express-validator/check'
+import { body, param, query } from 'express-validator/check'
 import { logger } from '../../helpers/logger'
 import { areValidationErrors } from './utils'
-import { isPluginNameValid, isPluginTypeValid, isPluginVersionValid, isNpmPluginNameValid } from '../../helpers/custom-validators/plugins'
+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 { 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 = [
+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'),
@@ -17,7 +20,8 @@ const servePluginStaticDirectoryValidator = [
 
     if (areValidationErrors(req, res)) return
 
-    const plugin = PluginManager.Instance.getRegisteredPluginOrTheme(req.params.pluginName)
+    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)
@@ -30,7 +34,7 @@ const servePluginStaticDirectoryValidator = [
 ]
 
 const listPluginsValidator = [
-  query('type')
+  query('pluginType')
     .optional()
     .custom(isPluginTypeValid).withMessage('Should have a valid plugin type'),
   query('uninstalled')
@@ -47,14 +51,26 @@ const listPluginsValidator = [
   }
 ]
 
-const installPluginValidator = [
-  body('npmName').custom(isNpmPluginNameValid).withMessage('Should have a valid npm name'),
+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 installPluginValidator parameters', { parameters: req.body })
+    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()
   }
 ]
@@ -63,7 +79,7 @@ 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 managePluginValidator parameters', { parameters: req.body })
+    logger.debug('Checking uninstallPluginValidator parameters', { parameters: req.body })
 
     if (areValidationErrors(req, res)) return
 
@@ -71,15 +87,15 @@ const uninstallPluginValidator = [
   }
 ]
 
-const enabledPluginValidator = [
-  body('name').custom(isPluginNameValid).withMessage('Should have a valid plugin name'),
+const existingPluginValidator = [
+  param('npmName').custom(isPluginNameValid).withMessage('Should have a valid plugin name'),
 
   async (req: express.Request, res: express.Response, next: express.NextFunction) => {
-    logger.debug('Checking enabledPluginValidator parameters', { parameters: req.body })
+    logger.debug('Checking enabledPluginValidator parameters', { parameters: req.params })
 
     if (areValidationErrors(req, res)) return
 
-    const plugin = await PluginModel.load(req.body.name)
+    const plugin = await PluginModel.loadByNpmName(req.params.npmName)
     if (!plugin) {
       return res.status(404)
          .json({ error: 'Plugin not found' })
@@ -104,13 +120,40 @@ const updatePluginSettingsValidator = [
   }
 ]
 
+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'),
+
+  (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,
-  enabledPluginValidator,
-  installPluginValidator,
+  listAvailablePluginsValidator,
+  existingPluginValidator,
+  installOrUpdatePluginValidator,
   listPluginsValidator
 }