Improve NSFW system

* Add NSFW flags to videos so the publisher can add more NSFW context
 * Add NSFW summary to videos, similar to content warning system so the
   publisher has a free text to describe NSFW aspect of its video
 * Add additional "warn" NSFW policy: the video thumbnail is not blurred
   and we display a tag below the video miniature, the video player
   includes the NSFW warning (with context if available) and it also
   prevent autoplay
 * "blur" NSFW settings inherits "warn" policy and also blur the video
   thumbnail
 * Add NSFW flag settings to users so they can have more granular
   control about what content they want to hide, warn or display

server/core/helpers/express-utils.ts

@@ -1,6 +1,7 @@
+import { VideosCommonQuery } from '@peertube/peertube-models'
+import { getLowercaseExtension } from '@peertube/peertube-node-utils'
 import express, { RequestHandler } from 'express'
 import multer, { diskStorage } from 'multer'
-import { getLowercaseExtension } from '@peertube/peertube-node-utils'
 import { CONFIG } from '../initializers/config.js'
 import { REMOTE_SCHEME } from '../initializers/constants.js'
 import { isArray } from './custom-validators/misc.js'
@@ -8,14 +9,33 @@ import { logger } from './logger.js'
 import { deleteFileAndCatch, generateRandomString } from './utils.js'
 import { getExtFromMimetype } from './video.js'
 
-function buildNSFWFilter (res?: express.Response, paramNSFW?: string) {
-  if (paramNSFW === 'true') return true
-  if (paramNSFW === 'false') return false
-  if (paramNSFW === 'both') return undefined
+// ---------------------------------------------------------------------------
+// Extract NSFW Filters options to list videos
+// ---------------------------------------------------------------------------
 
-  if (res?.locals.oauth) {
-    const user = res.locals.oauth.token.User
+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
 
@@ -29,7 +49,35 @@ function buildNSFWFilter (res?: express.Response, paramNSFW?: string) {
   return null
 }
 
-function cleanUpReqFiles (req: express.Request) {
+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
 
@@ -45,7 +93,7 @@ function cleanUpReqFiles (req: express.Request) {
   }
 }
 
-function getHostWithPort (host: string) {
+export function getHostWithPort (host: string) {
   const splitted = host.split(':')
 
   // The port was not specified
@@ -58,7 +106,7 @@ function getHostWithPort (host: string) {
   return host
 }
 
-function createReqFiles (
+export function createReqFiles (
   fieldNames: string[],
   mimeTypes: { [id: string]: string | string[] },
   destination = CONFIG.STORAGE.TMP_DIR
@@ -84,7 +132,7 @@ function createReqFiles (
   return multer({ storage }).fields(fields)
 }
 
-function createAnyReqFiles (
+export function createAnyReqFiles (
   mimeTypes: { [id: string]: string | string[] },
   fileFilter: (req: express.Request, file: Express.Multer.File, cb: (err: Error, result: boolean) => void) => void
 ): RequestHandler {
@@ -101,29 +149,19 @@ function createAnyReqFiles (
   return multer({ storage, fileFilter }).any()
 }
 
-function isUserAbleToSearchRemoteURI (res: express.Response) {
+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)
 }
 
-function getCountVideos (req: express.Request) {
+export function getCountVideos (req: express.Request) {
   return req.query.skipCount !== true
 }
 
 // ---------------------------------------------------------------------------
-
-export {
-  buildNSFWFilter,
-  getHostWithPort,
-  createAnyReqFiles,
-  isUserAbleToSearchRemoteURI,
-  createReqFiles,
-  cleanUpReqFiles,
-  getCountVideos
-}
-
+// Private
 // ---------------------------------------------------------------------------
 
 async function generateReqFilename (