server/middlewares/validators/sort.ts

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