server/middlewares/validators/sort.ts

   1 import { query } from 'express-validator/check'
   2 import * as express from 'express'
   3
   4 import { checkErrors } from './utils'
   5 import { logger } from '../../helpers'
   6 import { SORTABLE_COLUMNS } from '../../initializers'
   7
   8 // Initialize constants here for better performances
   9 const SORTABLE_PODS_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.PODS)
  10 const SORTABLE_USERS_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.USERS)
  11 const SORTABLE_VIDEO_ABUSES_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.VIDEO_ABUSES)
  12 const SORTABLE_VIDEOS_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.VIDEOS)
  13 const SORTABLE_BLACKLISTS_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.BLACKLISTS)
  14
  15 const podsSortValidator = checkSort(SORTABLE_PODS_COLUMNS)
  16 const usersSortValidator = checkSort(SORTABLE_USERS_COLUMNS)
  17 const videoAbusesSortValidator = checkSort(SORTABLE_VIDEO_ABUSES_COLUMNS)
  18 const videosSortValidator = checkSort(SORTABLE_VIDEOS_COLUMNS)
  19 const blacklistSortValidator = checkSort(SORTABLE_BLACKLISTS_COLUMNS)
  20
  21 // ---------------------------------------------------------------------------
  22
  23 export {
  24   podsSortValidator,
  25   usersSortValidator,
  26   videoAbusesSortValidator,
  27   videosSortValidator,
  28   blacklistSortValidator
  29 }
  30
  31 // ---------------------------------------------------------------------------
  32
  33 function checkSort (sortableColumns: string[]) {
  34   return [
  35     query('sort').optional().isIn(sortableColumns).withMessage('Should have correct sortable column'),
  36
  37     (req: express.Request, res: express.Response, next: express.NextFunction) => {
  38       logger.debug('Checking sort parameters', { parameters: req.query })
  39
  40       checkErrors(req, res, next)
  41     }
  42   ]
  43 }
  44
  45 function createSortableColumns (sortableColumns: string[]) {
  46   const sortableColumnDesc = sortableColumns.map(sortableColumn => '-' + sortableColumn)
  47
  48   return sortableColumns.concat(sortableColumnDesc)
  49 }