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_USERS_COLUMNS = createSortableColumns(SORTABLE_COLUMNS.USERS)
  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 videoAbusesSortValidator = checkSort(SORTABLE_VIDEO_ABUSES_COLUMNS)
  19 const videosSortValidator = checkSort(SORTABLE_VIDEOS_COLUMNS)
  20 const blacklistSortValidator = checkSort(SORTABLE_BLACKLISTS_COLUMNS)
  21 const videoChannelsSortValidator = checkSort(SORTABLE_VIDEO_CHANNELS_COLUMNS)
  22 const followersSortValidator = checkSort(SORTABLE_FOLLOWERS_COLUMNS)
  23 const followingSortValidator = checkSort(SORTABLE_FOLLOWING_COLUMNS)
  24
  25 // ---------------------------------------------------------------------------
  26
  27 export {
  28   usersSortValidator,
  29   videoAbusesSortValidator,
  30   videoChannelsSortValidator,
  31   videosSortValidator,
  32   blacklistSortValidator,
  33   followersSortValidator,
  34   followingSortValidator
  35 }
  36
  37 // ---------------------------------------------------------------------------
  38
  39 function checkSort (sortableColumns: string[]) {
  40   return [
  41     query('sort').optional().isIn(sortableColumns).withMessage('Should have correct sortable column'),
  42
  43     (req: express.Request, res: express.Response, next: express.NextFunction) => {
  44       logger.debug('Checking sort parameters', { parameters: req.query })
  45
  46       checkErrors(req, res, next)
  47     }
  48   ]
  49 }
  50
  51 function createSortableColumns (sortableColumns: string[]) {
  52   const sortableColumnDesc = sortableColumns.map(sortableColumn => '-' + sortableColumn)
  53
  54   return sortableColumns.concat(sortableColumnDesc)
  55 }