Merge branch 'release/3.3.0' into develop

[github/Chocobozzz/PeerTube.git] / server / middlewares / validators / search.ts

import * as express from 'express'
import { query } from 'express-validator'
import { isSearchTargetValid } from '@server/helpers/custom-validators/search'
import { isHostValid } from '@server/helpers/custom-validators/servers'
import { areUUIDsValid, isDateValid, isNotEmptyStringArray, toCompleteUUIDs } from '../../helpers/custom-validators/misc'
import { logger } from '../../helpers/logger'
import { areValidationErrors } from './shared'

const videosSearchValidator = [
  query('search').optional().not().isEmpty().withMessage('Should have a valid search'),

  query('host')
    .optional()
    .custom(isHostValid).withMessage('Should have a valid host'),

  query('startDate')
    .optional()
    .custom(isDateValid).withMessage('Should have a start date that conforms to ISO 8601'),
  query('endDate')
    .optional()
    .custom(isDateValid).withMessage('Should have a end date that conforms to ISO 8601'),

  query('originallyPublishedStartDate')
    .optional()
    .custom(isDateValid).withMessage('Should have a published start date that conforms to ISO 8601'),
  query('originallyPublishedEndDate')
    .optional()
    .custom(isDateValid).withMessage('Should have a published end date that conforms to ISO 8601'),

  query('durationMin')
    .optional()
    .isInt().withMessage('Should have a valid min duration'),
  query('durationMax')
    .optional()
    .isInt().withMessage('Should have a valid max duration'),

  query('uuids')
    .optional()
    .toArray()
    .customSanitizer(toCompleteUUIDs)
    .custom(areUUIDsValid).withMessage('Should have valid uuids'),

  query('searchTarget').optional().custom(isSearchTargetValid).withMessage('Should have a valid search target'),

  (req: express.Request, res: express.Response, next: express.NextFunction) => {
    logger.debug('Checking videos search query', { parameters: req.query })

    if (areValidationErrors(req, res)) return

    return next()
  }
]

const videoChannelsListSearchValidator = [
  query('search')
    .optional()
    .not().isEmpty().withMessage('Should have a valid search'),

  query('host')
    .optional()
    .custom(isHostValid).withMessage('Should have a valid host'),

  query('searchTarget')
    .optional()
    .custom(isSearchTargetValid).withMessage('Should have a valid search target'),

  query('handles')
    .optional()
    .toArray()
    .custom(isNotEmptyStringArray).withMessage('Should have valid handles'),

  (req: express.Request, res: express.Response, next: express.NextFunction) => {
    logger.debug('Checking video channels search query', { parameters: req.query })

    if (areValidationErrors(req, res)) return

    return next()
  }
]

const videoPlaylistsListSearchValidator = [
  query('search')
    .optional()
    .not().isEmpty().withMessage('Should have a valid search'),

  query('host')
    .optional()
    .custom(isHostValid).withMessage('Should have a valid host'),

  query('searchTarget')
    .optional()
    .custom(isSearchTargetValid).withMessage('Should have a valid search target'),

  query('uuids')
    .optional()
    .toArray()
    .customSanitizer(toCompleteUUIDs)
    .custom(areUUIDsValid).withMessage('Should have valid uuids'),

  (req: express.Request, res: express.Response, next: express.NextFunction) => {
    logger.debug('Checking video playlists search query', { parameters: req.query })

    if (areValidationErrors(req, res)) return

    return next()
  }
]

// ---------------------------------------------------------------------------

export {
  videosSearchValidator,
  videoChannelsListSearchValidator,
  videoPlaylistsListSearchValidator
}