Skip to content

ActivityPub-federated video streaming platform using P2P directly in your web browser

7.2 KB
Raw Blame
import { forceNumber } from '@peertube/peertube-core-utils'
import { NSFWFlag, VideosCommonQuery } from '@peertube/peertube-models'
import { getLowercaseExtension } from '@peertube/peertube-node-utils'
import express, { RequestHandler } from 'express'
import multer, { diskStorage } from 'multer'
import { Duplex, Readable } from 'stream'
import { pipeline } from 'stream/promises'
import { CONFIG } from '../initializers/config.js'
import { REMOTE_SCHEME } from '../initializers/constants.js'
import { isArray } from './custom-validators/misc.js'
import { deleteFileAndCatch } from './fs.js'
import { createLogger } from './logger.js'
import { generateRandomString } from './utils.js'
import { getExtFromMimetype } from './video.js'

const logger = createLogger()

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

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

    nsfwFlagsIncluded: CONFIG.NSFW_FLAGS_SETTINGS.ENABLED
      ? buildNSFWFlagsIncluded(options)
      : NSFWFlag.NONE,

    nsfwFlagsExcluded: CONFIG.NSFW_FLAGS_SETTINGS.ENABLED
      ? buildNSFWFlagsExcluded(options)
      : NSFWFlag.NONE
  }
}

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, defParamCharset: 'utf8' }).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
}

export function getAuthUser (res: express.Response) {
  return res.locals.oauth
    ? res.locals.oauth.token.User
    : undefined
}

// Only supports a single "bytes=start-end" range
export function parseRangeHeader (rangeHeader: string | undefined, size: number):
  | { start: number, end: number }
  | 'unsatisfiable'
  | undefined
{
  if (!rangeHeader) return undefined

  const match = /^bytes=(\d*)-(\d*)$/.exec(rangeHeader)
  if (!match || (!match[1] && !match[2])) return undefined

  const [ , rawStart, rawEnd ] = match

  let start: number
  let end: number

  if (rawStart === '') {
    start = Math.max(size - forceNumber(rawEnd), 0)

    end = size - 1
  } else {
    start = forceNumber(rawStart)

    end = rawEnd === ''
      ? size - 1 :
      Math.min(forceNumber(rawEnd), size - 1)
  }

  if (Number.isNaN(start) || Number.isNaN(end) || start > end || start >= size) {
    return 'unsatisfiable'
  }

  return { start, end }
}

// Pipe streams to the HTTP response, ignoring the errors emitted when the client aborts the request
export async function pipelineToResponse (options: {
  streams: (Readable | Duplex)[]
  res: express.Response
  logLabel: string
}) {
  const { streams, res, logLabel } = options

  try {
    await pipeline([ ...streams, res ])
  } catch (err) {
    // The client can close the connection at any time: this is not a server error
    if ([ 'ERR_STREAM_PREMATURE_CLOSE', 'ECONNRESET', 'EPIPE' ].includes(err.code)) {
      logger.debug(`Client aborted ${logLabel}`, { err })
      return
    }

    throw err
  }
}

// ---------------------------------------------------------------------------
// 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)
}