server/helpers/express-utils.ts

   1 import express, { RequestHandler } from 'express'
   2 import multer, { diskStorage } from 'multer'
   3 import { getLowercaseExtension } from '@shared/core-utils'
   4 import { HttpStatusCode } from '../../shared/models/http/http-error-codes'
   5 import { CONFIG } from '../initializers/config'
   6 import { REMOTE_SCHEME } from '../initializers/constants'
   7 import { isArray } from './custom-validators/misc'
   8 import { logger } from './logger'
   9 import { deleteFileAndCatch, generateRandomString } from './utils'
  10 import { getExtFromMimetype } from './video'
  11
  12 function buildNSFWFilter (res?: express.Response, paramNSFW?: string) {
  13   if (paramNSFW === 'true') return true
  14   if (paramNSFW === 'false') return false
  15   if (paramNSFW === 'both') return undefined
  16
  17   if (res?.locals.oauth) {
  18     const user = res.locals.oauth.token.User
  19
  20     // User does not want NSFW videos
  21     if (user.nsfwPolicy === 'do_not_list') return false
  22
  23     // Both
  24     return undefined
  25   }
  26
  27   if (CONFIG.INSTANCE.DEFAULT_NSFW_POLICY === 'do_not_list') return false
  28
  29   // Display all
  30   return null
  31 }
  32
  33 function cleanUpReqFiles (req: express.Request) {
  34   const filesObject = req.files
  35   if (!filesObject) return
  36
  37   if (isArray(filesObject)) {
  38     filesObject.forEach(f => deleteFileAndCatch(f.path))
  39     return
  40   }
  41
  42   for (const key of Object.keys(filesObject)) {
  43     const files = filesObject[key]
  44
  45     files.forEach(f => deleteFileAndCatch(f.path))
  46   }
  47 }
  48
  49 function getHostWithPort (host: string) {
  50   const splitted = host.split(':')
  51
  52   // The port was not specified
  53   if (splitted.length === 1) {
  54     if (REMOTE_SCHEME.HTTP === 'https') return host + ':443'
  55
  56     return host + ':80'
  57   }
  58
  59   return host
  60 }
  61
  62 function badRequest (_req: express.Request, res: express.Response) {
  63   return res.type('json')
  64             .status(HttpStatusCode.BAD_REQUEST_400)
  65             .end()
  66 }
  67
  68 function createReqFiles (
  69   fieldNames: string[],
  70   mimeTypes: { [id: string]: string | string[] },
  71   destination = CONFIG.STORAGE.TMP_DIR
  72 ): RequestHandler {
  73   const storage = diskStorage({
  74     destination: (req, file, cb) => {
  75       cb(null, destination)
  76     },
  77
  78     filename: (req, file, cb) => {
  79       return generateReqFilename(file, mimeTypes, cb)
  80     }
  81   })
  82
  83   const fields: { name: string, maxCount: number }[] = []
  84   for (const fieldName of fieldNames) {
  85     fields.push({
  86       name: fieldName,
  87       maxCount: 1
  88     })
  89   }
  90
  91   return multer({ storage }).fields(fields)
  92 }
  93
  94 function createAnyReqFiles (
  95   mimeTypes: { [id: string]: string | string[] },
  96   fileFilter: (req: express.Request, file: Express.Multer.File, cb: (err: Error, result: boolean) => void) => void
  97 ): RequestHandler {
  98   const storage = diskStorage({
  99     destination: (req, file, cb) => {
 100       cb(null, CONFIG.STORAGE.TMP_DIR)
 101     },
 102
 103     filename: (req, file, cb) => {
 104       return generateReqFilename(file, mimeTypes, cb)
 105     }
 106   })
 107
 108   return multer({ storage, fileFilter }).any()
 109 }
 110
 111 function isUserAbleToSearchRemoteURI (res: express.Response) {
 112   const user = res.locals.oauth ? res.locals.oauth.token.User : undefined
 113
 114   return CONFIG.SEARCH.REMOTE_URI.ANONYMOUS === true ||
 115     (CONFIG.SEARCH.REMOTE_URI.USERS === true && user !== undefined)
 116 }
 117
 118 function getCountVideos (req: express.Request) {
 119   return req.query.skipCount !== true
 120 }
 121
 122 // ---------------------------------------------------------------------------
 123
 124 export {
 125   buildNSFWFilter,
 126   getHostWithPort,
 127   createAnyReqFiles,
 128   isUserAbleToSearchRemoteURI,
 129   badRequest,
 130   createReqFiles,
 131   cleanUpReqFiles,
 132   getCountVideos
 133 }
 134
 135 // ---------------------------------------------------------------------------
 136
 137 async function generateReqFilename (
 138   file: Express.Multer.File,
 139   mimeTypes: { [id: string]: string | string[] },
 140   cb: (err: Error, name: string) => void
 141 ) {
 142   let extension: string
 143   const fileExtension = getLowercaseExtension(file.originalname)
 144   const extensionFromMimetype = getExtFromMimetype(mimeTypes, file.mimetype)
 145
 146   // Take the file extension if we don't understand the mime type
 147   if (!extensionFromMimetype) {
 148     extension = fileExtension
 149   } else {
 150     // Take the first available extension for this mimetype
 151     extension = extensionFromMimetype
 152   }
 153
 154   let randomString = ''
 155
 156   try {
 157     randomString = await generateRandomString(16)
 158   } catch (err) {
 159     logger.error('Cannot generate random string for file name.', { err })
 160     randomString = 'fake-random-string'
 161   }
 162
 163   cb(null, randomString + extension)
 164 }