server/middlewares/validators/sort.ts

   1 import express from 'express'
   2 import { query } from 'express-validator'
   3 import { logger } from '@server/helpers/logger'
   4 import { SORTABLE_COLUMNS } from '../../initializers/constants'
   5 import { areValidationErrors } from './shared'
   6
   7 function checkSortFactory (columns: string[], tags: string[] = []) {
   8   return checkSort(createSortableColumns(columns), tags)
   9 }
  10
  11 function checkSort (sortableColumns: string[], tags: string[] = []) {
  12   return [
  13     query('sort')
  14       .optional()
  15       .isIn(sortableColumns),
  16
  17     (req: express.Request, res: express.Response, next: express.NextFunction) => {
  18       logger.debug('Checking sort parameters', { parameters: req.query, tags })
  19
  20       if (areValidationErrors(req, res)) return
  21
  22       return next()
  23     }
  24   ]
  25 }
  26
  27 function createSortableColumns (sortableColumns: string[]) {
  28   const sortableColumnDesc = sortableColumns.map(sortableColumn => '-' + sortableColumn)
  29
  30   return sortableColumns.concat(sortableColumnDesc)
  31 }
  32
  33 const adminUsersSortValidator = checkSortFactory(SORTABLE_COLUMNS.ADMIN_USERS)
  34 const accountsSortValidator = checkSortFactory(SORTABLE_COLUMNS.ACCOUNTS)
  35 const jobsSortValidator = checkSortFactory(SORTABLE_COLUMNS.JOBS, [ 'jobs' ])
  36 const abusesSortValidator = checkSortFactory(SORTABLE_COLUMNS.ABUSES)
  37 const videosSortValidator = checkSortFactory(SORTABLE_COLUMNS.VIDEOS)
  38 const videoImportsSortValidator = checkSortFactory(SORTABLE_COLUMNS.VIDEO_IMPORTS)
  39 const videosSearchSortValidator = checkSortFactory(SORTABLE_COLUMNS.VIDEOS_SEARCH)
  40 const videoChannelsSearchSortValidator = checkSortFactory(SORTABLE_COLUMNS.VIDEO_CHANNELS_SEARCH)
  41 const videoPlaylistsSearchSortValidator = checkSortFactory(SORTABLE_COLUMNS.VIDEO_PLAYLISTS_SEARCH)
  42 const videoCommentsValidator = checkSortFactory(SORTABLE_COLUMNS.VIDEO_COMMENTS)
  43 const videoCommentThreadsSortValidator = checkSortFactory(SORTABLE_COLUMNS.VIDEO_COMMENT_THREADS)
  44 const videoRatesSortValidator = checkSortFactory(SORTABLE_COLUMNS.VIDEO_RATES)
  45 const blacklistSortValidator = checkSortFactory(SORTABLE_COLUMNS.BLACKLISTS)
  46 const videoChannelsSortValidator = checkSortFactory(SORTABLE_COLUMNS.VIDEO_CHANNELS)
  47 const instanceFollowersSortValidator = checkSortFactory(SORTABLE_COLUMNS.INSTANCE_FOLLOWERS)
  48 const instanceFollowingSortValidator = checkSortFactory(SORTABLE_COLUMNS.INSTANCE_FOLLOWING)
  49 const userSubscriptionsSortValidator = checkSortFactory(SORTABLE_COLUMNS.USER_SUBSCRIPTIONS)
  50 const accountsBlocklistSortValidator = checkSortFactory(SORTABLE_COLUMNS.ACCOUNTS_BLOCKLIST)
  51 const serversBlocklistSortValidator = checkSortFactory(SORTABLE_COLUMNS.SERVERS_BLOCKLIST)
  52 const userNotificationsSortValidator = checkSortFactory(SORTABLE_COLUMNS.USER_NOTIFICATIONS)
  53 const videoPlaylistsSortValidator = checkSortFactory(SORTABLE_COLUMNS.VIDEO_PLAYLISTS)
  54 const pluginsSortValidator = checkSortFactory(SORTABLE_COLUMNS.PLUGINS)
  55 const availablePluginsSortValidator = checkSortFactory(SORTABLE_COLUMNS.AVAILABLE_PLUGINS)
  56 const videoRedundanciesSortValidator = checkSortFactory(SORTABLE_COLUMNS.VIDEO_REDUNDANCIES)
  57 const videoChannelSyncsSortValidator = checkSortFactory(SORTABLE_COLUMNS.VIDEO_CHANNEL_SYNCS)
  58
  59 const accountsFollowersSortValidator = checkSortFactory(SORTABLE_COLUMNS.ACCOUNT_FOLLOWERS)
  60 const videoChannelsFollowersSortValidator = checkSortFactory(SORTABLE_COLUMNS.CHANNEL_FOLLOWERS)
  61
  62 // ---------------------------------------------------------------------------
  63
  64 export {
  65   adminUsersSortValidator,
  66   abusesSortValidator,
  67   videoChannelsSortValidator,
  68   videoImportsSortValidator,
  69   videoCommentsValidator,
  70   videosSearchSortValidator,
  71   videosSortValidator,
  72   blacklistSortValidator,
  73   accountsSortValidator,
  74   instanceFollowersSortValidator,
  75   instanceFollowingSortValidator,
  76   jobsSortValidator,
  77   videoCommentThreadsSortValidator,
  78   videoRatesSortValidator,
  79   userSubscriptionsSortValidator,
  80   availablePluginsSortValidator,
  81   videoChannelsSearchSortValidator,
  82   accountsBlocklistSortValidator,
  83   serversBlocklistSortValidator,
  84   userNotificationsSortValidator,
  85   videoPlaylistsSortValidator,
  86   videoRedundanciesSortValidator,
  87   videoPlaylistsSearchSortValidator,
  88   accountsFollowersSortValidator,
  89   videoChannelsFollowersSortValidator,
  90   videoChannelSyncsSortValidator,
  91   pluginsSortValidator
  92 }