Peertube/server/core/helpers/express-utils.ts

import { VideosCommonQuery } from '@peertube/peertube-models'
import { getLowercaseExtension } from '@peertube/peertube-node-utils'
import express, { RequestHandler } from 'express'
import multer, { diskStorage } from 'multer'
import { CONFIG } from '../initializers/config.js'
import { REMOTE_SCHEME } from '../initializers/constants.js'
import { isArray } from './custom-validators/misc.js'
import { logger } from './logger.js'
import { deleteFileAndCatch, generateRandomString } from './utils.js'
import { getExtFromMimetype } from './video.js'

// ---------------------------------------------------------------------------
// Extract NSFW Filters options to list videos
// ---------------------------------------------------------------------------

export function buildNSFWFilters (options: {
  req?: express.Request
  res?: express.Response
} = {}) {
  return {
    nsfw: buildNSFWFilter(options),
    nsfwFlagsIncluded: buildNSFWFlagsIncluded(options),
    nsfwFlagsExcluded: buildNSFWFlagsExcluded(options)
  }
}

function buildNSFWFilter (options: {
  req?: express.Request
  res?: express.Response
}) {
  const query = options.req?.query.nsfw as VideosCommonQuery['nsfw']
  const user = options.res?.locals.oauth?.token.User

  if (query === 'true') return true
  if (query === 'false') return false
  if (query === 'both') return undefined

  if (user) {
    // User does not want NSFW videos
    if (user.nsfwPolicy === 'do_not_list') return false

    // Both
    return undefined
  }

  if (CONFIG.INSTANCE.DEFAULT_NSFW_POLICY === 'do_not_list') return false

  // Display all
  return null
}

function buildNSFWFlagsIncluded (options: {
  req?: express.Request
  res?: express.Response
}) {
  const query = options.req?.query.nsfwFlagsIncluded as VideosCommonQuery['nsfwFlagsIncluded']
  const user = options.res?.locals.oauth?.token.User

  if (query) return query
  if (user) return user.nsfwFlagsWarned | user.nsfwFlagsBlurred | user.nsfwFlagsDisplayed

  return undefined
}

function buildNSFWFlagsExcluded (options: {
  req?: express.Request
  res?: express.Response
}) {
  const query = options.req?.query.nsfwFlagsExcluded as VideosCommonQuery['nsfwFlagsExcluded']
  const user = options.res?.locals.oauth?.token.User

  if (query) return query
  if (user) return user.nsfwFlagsHidden

  return undefined
}

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

export function cleanUpReqFiles (req: express.Request) {
  const filesObject = req.files
  if (!filesObject) return

  if (isArray(filesObject)) {
    filesObject.forEach(f => deleteFileAndCatch(f.path))
    return
  }

  for (const key of Object.keys(filesObject)) {
    const files = filesObject[key]

    files.forEach(f => deleteFileAndCatch(f.path))
  }
}

export function getHostWithPort (host: string) {
  const splitted = host.split(':')

  // The port was not specified
  if (splitted.length === 1) {
    if (REMOTE_SCHEME.HTTP === 'https') return host + ':443'

    return host + ':80'
  }

  return host
}

export function createReqFiles (
  fieldNames: string[],
  mimeTypes: { [id: string]: string | string[] },
  destination = CONFIG.STORAGE.TMP_DIR
): RequestHandler {
  const storage = diskStorage({
    destination: (req, file, cb) => {
      cb(null, destination)
    },

    filename: (req, file, cb) => {
      return generateReqFilename(file, mimeTypes, cb)
    }
  })

  const fields: { name: string, maxCount: number }[] = []
  for (const fieldName of fieldNames) {
    fields.push({
      name: fieldName,
      maxCount: 1
    })
  }

  return multer({ storage }).fields(fields)
}

export function createAnyReqFiles (
  mimeTypes: { [id: string]: string | string[] },
  fileFilter: (req: express.Request, file: Express.Multer.File, cb: (err: Error, result: boolean) => void) => void
): RequestHandler {
  const storage = diskStorage({
    destination: (req, file, cb) => {
      cb(null, CONFIG.STORAGE.TMP_DIR)
    },

    filename: (req, file, cb) => {
      return generateReqFilename(file, mimeTypes, cb)
    }
  })

  return multer({ storage, fileFilter }).any()
}

export function isUserAbleToSearchRemoteURI (res: express.Response) {
  const user = res.locals.oauth ? res.locals.oauth.token.User : undefined

  return CONFIG.SEARCH.REMOTE_URI.ANONYMOUS === true ||
    (CONFIG.SEARCH.REMOTE_URI.USERS === true && user !== undefined)
}

export function getCountVideos (req: express.Request) {
  return req.query.skipCount !== true
}

// ---------------------------------------------------------------------------
// Private
// ---------------------------------------------------------------------------

async function generateReqFilename (
  file: Express.Multer.File,
  mimeTypes: { [id: string]: string | string[] },
  cb: (err: Error, name: string) => void
) {
  let extension: string
  const fileExtension = getLowercaseExtension(file.originalname)
  const extensionFromMimetype = getExtFromMimetype(mimeTypes, file.mimetype)

  // Take the file extension if we don't understand the mime type
  if (!extensionFromMimetype) {
    extension = fileExtension
  } else {
    // Take the first available extension for this mimetype
    extension = extensionFromMimetype
  }

  let randomString = ''

  try {
    randomString = await generateRandomString(16)
  } catch (err) {
    logger.error('Cannot generate random string for file name.', { err })
    randomString = 'fake-random-string'
  }

  cb(null, randomString + extension)
}