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_VIDEO_COMMENT_THREADS_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.VIDEO_COMMENT_THREADS)
  13 const SORTABLE_BLACKLISTS_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.BLACKLISTS)
  14 const SORTABLE_VIDEO_CHANNELS_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.VIDEO_CHANNELS)
  15 const SORTABLE_FOLLOWERS_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.FOLLOWERS)
  16 const SORTABLE_FOLLOWING_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.FOLLOWING)
  17
  18 const usersSortValidator = checkSort(SORTABLE_USERS_COLUMNS)
  19 const jobsSortValidator = checkSort(SORTABLE_JOBS_COLUMNS)
  20 const videoAbusesSortValidator = checkSort(SORTABLE_VIDEO_ABUSES_COLUMNS)
  21 const videosSortValidator = checkSort(SORTABLE_VIDEOS_COLUMNS)
  22 const videoCommentThreadsSortValidator = checkSort(SORTABLE_VIDEO_COMMENT_THREADS_COLUMNS)
  23 const blacklistSortValidator = checkSort(SORTABLE_BLACKLISTS_COLUMNS)
  24 const videoChannelsSortValidator = checkSort(SORTABLE_VIDEO_CHANNELS_COLUMNS)
  25 const followersSortValidator = checkSort(SORTABLE_FOLLOWERS_COLUMNS)
  26 const followingSortValidator = checkSort(SORTABLE_FOLLOWING_COLUMNS)
  27
  28 // ---------------------------------------------------------------------------
  29
  30 export {
  31   usersSortValidator,
  32   videoAbusesSortValidator,
  33   videoChannelsSortValidator,
  34   videosSortValidator,
  35   blacklistSortValidator,
  36   followersSortValidator,
  37   followingSortValidator,
  38   jobsSortValidator,
  39   videoCommentThreadsSortValidator
  40 }
  41
  42 // ---------------------------------------------------------------------------
  43
  44 function checkSort (sortableColumns: string[]) {
  45   return [
  46     query('sort').optional().isIn(sortableColumns).withMessage('Should have correct sortable column'),
  47
  48     (req: express.Request, res: express.Response, next: express.NextFunction) => {
  49       logger.debug('Checking sort parameters', { parameters: req.query })
  50
  51       if (areValidationErrors(req, res)) return
  52
  53       return next()
  54     }
  55   ]
  56 }
  57
  58 function createSortableColumns (sortableColumns: string[]) {
  59   const sortableColumnDesc = sortableColumns.map(sortableColumn => '-' + sortableColumn)
  60
  61   return sortableColumns.concat(sortableColumnDesc)
  62 }