server/middlewares/validators/sort.ts

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