server/lib/video.ts

   1 import { UploadFiles } from 'express'
   2 import memoizee from 'memoizee'
   3 import { Transaction } from 'sequelize/types'
   4 import { CONFIG } from '@server/initializers/config'
   5 import { DEFAULT_AUDIO_RESOLUTION, JOB_PRIORITY, MEMOIZE_LENGTH, MEMOIZE_TTL } from '@server/initializers/constants'
   6 import { TagModel } from '@server/models/video/tag'
   7 import { VideoModel } from '@server/models/video/video'
   8 import { VideoJobInfoModel } from '@server/models/video/video-job-info'
   9 import { FilteredModelAttributes } from '@server/types'
  10 import { MThumbnail, MUserId, MVideoFile, MVideoFullLight, MVideoTag, MVideoThumbnail, MVideoUUID } from '@server/types/models'
  11 import { ManageVideoTorrentPayload, ThumbnailType, VideoCreate, VideoPrivacy, VideoState, VideoTranscodingPayload } from '@shared/models'
  12 import { CreateJobArgument, CreateJobOptions, JobQueue } from './job-queue/job-queue'
  13 import { updateVideoMiniatureFromExisting } from './thumbnail'
  14 import { moveFilesIfPrivacyChanged } from './video-privacy'
  15
  16 function buildLocalVideoFromReq (videoInfo: VideoCreate, channelId: number): FilteredModelAttributes<VideoModel> {
  17   return {
  18     name: videoInfo.name,
  19     remote: false,
  20     category: videoInfo.category,
  21     licence: videoInfo.licence ?? CONFIG.DEFAULTS.PUBLISH.LICENCE,
  22     language: videoInfo.language,
  23     commentsEnabled: videoInfo.commentsEnabled ?? CONFIG.DEFAULTS.PUBLISH.COMMENTS_ENABLED,
  24     downloadEnabled: videoInfo.downloadEnabled ?? CONFIG.DEFAULTS.PUBLISH.DOWNLOAD_ENABLED,
  25     waitTranscoding: videoInfo.waitTranscoding || false,
  26     nsfw: videoInfo.nsfw || false,
  27     description: videoInfo.description,
  28     support: videoInfo.support,
  29     privacy: videoInfo.privacy || VideoPrivacy.PRIVATE,
  30     channelId,
  31     originallyPublishedAt: videoInfo.originallyPublishedAt
  32       ? new Date(videoInfo.originallyPublishedAt)
  33       : null
  34   }
  35 }
  36
  37 async function buildVideoThumbnailsFromReq (options: {
  38   video: MVideoThumbnail
  39   files: UploadFiles
  40   fallback: (type: ThumbnailType) => Promise<MThumbnail>
  41   automaticallyGenerated?: boolean
  42 }) {
  43   const { video, files, fallback, automaticallyGenerated } = options
  44
  45   const promises = [
  46     {
  47       type: ThumbnailType.MINIATURE,
  48       fieldName: 'thumbnailfile'
  49     },
  50     {
  51       type: ThumbnailType.PREVIEW,
  52       fieldName: 'previewfile'
  53     }
  54   ].map(p => {
  55     const fields = files?.[p.fieldName]
  56
  57     if (fields) {
  58       return updateVideoMiniatureFromExisting({
  59         inputPath: fields[0].path,
  60         video,
  61         type: p.type,
  62         automaticallyGenerated: automaticallyGenerated || false
  63       })
  64     }
  65
  66     return fallback(p.type)
  67   })
  68
  69   return Promise.all(promises)
  70 }
  71
  72 // ---------------------------------------------------------------------------
  73
  74 async function setVideoTags (options: {
  75   video: MVideoTag
  76   tags: string[]
  77   transaction?: Transaction
  78 }) {
  79   const { video, tags, transaction } = options
  80
  81   const internalTags = tags || []
  82   const tagInstances = await TagModel.findOrCreateTags(internalTags, transaction)
  83
  84   await video.$set('Tags', tagInstances, { transaction })
  85   video.Tags = tagInstances
  86 }
  87
  88 // ---------------------------------------------------------------------------
  89
  90 async function buildOptimizeOrMergeAudioJob (options: {
  91   video: MVideoUUID
  92   videoFile: MVideoFile
  93   user: MUserId
  94   isNewVideo?: boolean // Default true
  95 }) {
  96   const { video, videoFile, user, isNewVideo } = options
  97
  98   let payload: VideoTranscodingPayload
  99
 100   if (videoFile.isAudio()) {
 101     payload = {
 102       type: 'merge-audio-to-webtorrent',
 103       resolution: DEFAULT_AUDIO_RESOLUTION,
 104       videoUUID: video.uuid,
 105       createHLSIfNeeded: true,
 106       isNewVideo
 107     }
 108   } else {
 109     payload = {
 110       type: 'optimize-to-webtorrent',
 111       videoUUID: video.uuid,
 112       isNewVideo
 113     }
 114   }
 115
 116   await VideoJobInfoModel.increaseOrCreate(payload.videoUUID, 'pendingTranscode')
 117
 118   return {
 119     type: 'video-transcoding' as 'video-transcoding',
 120     priority: await getTranscodingJobPriority(user),
 121     payload
 122   }
 123 }
 124
 125 async function buildTranscodingJob (payload: VideoTranscodingPayload, options: CreateJobOptions = {}) {
 126   await VideoJobInfoModel.increaseOrCreate(payload.videoUUID, 'pendingTranscode')
 127
 128   return { type: 'video-transcoding' as 'video-transcoding', payload, ...options }
 129 }
 130
 131 async function getTranscodingJobPriority (user: MUserId) {
 132   const now = new Date()
 133   const lastWeek = new Date(now.getFullYear(), now.getMonth(), now.getDate() - 7)
 134
 135   const videoUploadedByUser = await VideoModel.countVideosUploadedByUserSince(user.id, lastWeek)
 136
 137   return JOB_PRIORITY.TRANSCODING + videoUploadedByUser
 138 }
 139
 140 // ---------------------------------------------------------------------------
 141
 142 async function buildMoveToObjectStorageJob (options: {
 143   video: MVideoUUID
 144   previousVideoState: VideoState
 145   isNewVideo?: boolean // Default true
 146 }) {
 147   const { video, previousVideoState, isNewVideo = true } = options
 148
 149   await VideoJobInfoModel.increaseOrCreate(video.uuid, 'pendingMove')
 150
 151   return {
 152     type: 'move-to-object-storage' as 'move-to-object-storage',
 153     payload: {
 154       videoUUID: video.uuid,
 155       isNewVideo,
 156       previousVideoState
 157     }
 158   }
 159 }
 160
 161 // ---------------------------------------------------------------------------
 162
 163 async function getVideoDuration (videoId: number | string) {
 164   const video = await VideoModel.load(videoId)
 165
 166   const duration = video.isLive
 167     ? undefined
 168     : video.duration
 169
 170   return { duration, isLive: video.isLive }
 171 }
 172
 173 const getCachedVideoDuration = memoizee(getVideoDuration, {
 174   promise: true,
 175   max: MEMOIZE_LENGTH.VIDEO_DURATION,
 176   maxAge: MEMOIZE_TTL.VIDEO_DURATION
 177 })
 178
 179 // ---------------------------------------------------------------------------
 180
 181 async function addVideoJobsAfterUpdate (options: {
 182   video: MVideoFullLight
 183   isNewVideo: boolean
 184
 185   nameChanged: boolean
 186   oldPrivacy: VideoPrivacy
 187 }) {
 188   const { video, nameChanged, oldPrivacy, isNewVideo } = options
 189   const jobs: CreateJobArgument[] = []
 190
 191   const filePathChanged = await moveFilesIfPrivacyChanged(video, oldPrivacy)
 192
 193   if (!video.isLive && (nameChanged || filePathChanged)) {
 194     for (const file of (video.VideoFiles || [])) {
 195       const payload: ManageVideoTorrentPayload = { action: 'update-metadata', videoId: video.id, videoFileId: file.id }
 196
 197       jobs.push({ type: 'manage-video-torrent', payload })
 198     }
 199
 200     const hls = video.getHLSPlaylist()
 201
 202     for (const file of (hls?.VideoFiles || [])) {
 203       const payload: ManageVideoTorrentPayload = { action: 'update-metadata', streamingPlaylistId: hls.id, videoFileId: file.id }
 204
 205       jobs.push({ type: 'manage-video-torrent', payload })
 206     }
 207   }
 208
 209   jobs.push({
 210     type: 'federate-video',
 211     payload: {
 212       videoUUID: video.uuid,
 213       isNewVideo
 214     }
 215   })
 216
 217   const wasConfidentialVideo = new Set([ VideoPrivacy.PRIVATE, VideoPrivacy.UNLISTED, VideoPrivacy.INTERNAL ]).has(oldPrivacy)
 218
 219   if (wasConfidentialVideo) {
 220     jobs.push({
 221       type: 'notify',
 222       payload: {
 223         action: 'new-video',
 224         videoUUID: video.uuid
 225       }
 226     })
 227   }
 228
 229   return JobQueue.Instance.createSequentialJobFlow(...jobs)
 230 }
 231
 232 // ---------------------------------------------------------------------------
 233
 234 export {
 235   buildLocalVideoFromReq,
 236   buildVideoThumbnailsFromReq,
 237   setVideoTags,
 238   buildOptimizeOrMergeAudioJob,
 239   buildTranscodingJob,
 240   buildMoveToObjectStorageJob,
 241   getTranscodingJobPriority,
 242   addVideoJobsAfterUpdate,
 243   getCachedVideoDuration
 244 }