server/middlewares/validators/plugins.ts

   1 import * as express from 'express'
   2 import { param, query, body } from 'express-validator/check'
   3 import { logger } from '../../helpers/logger'
   4 import { areValidationErrors } from './utils'
   5 import { isPluginNameValid, isPluginTypeValid, isPluginVersionValid, isNpmPluginNameValid } from '../../helpers/custom-validators/plugins'
   6 import { PluginManager } from '../../lib/plugins/plugin-manager'
   7 import { isBooleanValid, isSafePath } from '../../helpers/custom-validators/misc'
   8 import { PluginModel } from '../../models/server/plugin'
   9
  10 const servePluginStaticDirectoryValidator = [
  11   param('pluginName').custom(isPluginNameValid).withMessage('Should have a valid plugin name'),
  12   param('pluginVersion').custom(isPluginVersionValid).withMessage('Should have a valid plugin version'),
  13   param('staticEndpoint').custom(isSafePath).withMessage('Should have a valid static endpoint'),
  14
  15   (req: express.Request, res: express.Response, next: express.NextFunction) => {
  16     logger.debug('Checking servePluginStaticDirectory parameters', { parameters: req.params })
  17
  18     if (areValidationErrors(req, res)) return
  19
  20     const plugin = PluginManager.Instance.getRegisteredPluginOrTheme(req.params.pluginName)
  21
  22     if (!plugin || plugin.version !== req.params.pluginVersion) {
  23       return res.sendStatus(404)
  24     }
  25
  26     res.locals.registeredPlugin = plugin
  27
  28     return next()
  29   }
  30 ]
  31
  32 const listPluginsValidator = [
  33   query('type')
  34     .optional()
  35     .custom(isPluginTypeValid).withMessage('Should have a valid plugin type'),
  36   query('uninstalled')
  37     .optional()
  38     .toBoolean()
  39     .custom(isBooleanValid).withMessage('Should have a valid uninstalled attribute'),
  40
  41   (req: express.Request, res: express.Response, next: express.NextFunction) => {
  42     logger.debug('Checking listPluginsValidator parameters', { parameters: req.query })
  43
  44     if (areValidationErrors(req, res)) return
  45
  46     return next()
  47   }
  48 ]
  49
  50 const installPluginValidator = [
  51   body('npmName').custom(isNpmPluginNameValid).withMessage('Should have a valid npm name'),
  52
  53   (req: express.Request, res: express.Response, next: express.NextFunction) => {
  54     logger.debug('Checking installPluginValidator parameters', { parameters: req.body })
  55
  56     if (areValidationErrors(req, res)) return
  57
  58     return next()
  59   }
  60 ]
  61
  62 const uninstallPluginValidator = [
  63   body('npmName').custom(isNpmPluginNameValid).withMessage('Should have a valid npm name'),
  64
  65   (req: express.Request, res: express.Response, next: express.NextFunction) => {
  66     logger.debug('Checking uninstallPluginValidator parameters', { parameters: req.body })
  67
  68     if (areValidationErrors(req, res)) return
  69
  70     return next()
  71   }
  72 ]
  73
  74 const existingPluginValidator = [
  75   param('npmName').custom(isPluginNameValid).withMessage('Should have a valid plugin name'),
  76
  77   async (req: express.Request, res: express.Response, next: express.NextFunction) => {
  78     logger.debug('Checking enabledPluginValidator parameters', { parameters: req.params })
  79
  80     if (areValidationErrors(req, res)) return
  81
  82     const plugin = await PluginModel.loadByNpmName(req.params.npmName)
  83     if (!plugin) {
  84       return res.status(404)
  85          .json({ error: 'Plugin not found' })
  86          .end()
  87     }
  88
  89     res.locals.plugin = plugin
  90
  91     return next()
  92   }
  93 ]
  94
  95 const updatePluginSettingsValidator = [
  96   body('settings').exists().withMessage('Should have settings'),
  97
  98   (req: express.Request, res: express.Response, next: express.NextFunction) => {
  99     logger.debug('Checking enabledPluginValidator parameters', { parameters: req.body })
 100
 101     if (areValidationErrors(req, res)) return
 102
 103     return next()
 104   }
 105 ]
 106
 107 // ---------------------------------------------------------------------------
 108
 109 export {
 110   servePluginStaticDirectoryValidator,
 111   updatePluginSettingsValidator,
 112   uninstallPluginValidator,
 113   existingPluginValidator,
 114   installPluginValidator,
 115   listPluginsValidator
 116 }