server/helpers/video.ts

   1 import { Response } from 'express'
   2 import { CONFIG } from '@server/initializers/config'
   3 import { DEFAULT_AUDIO_RESOLUTION } from '@server/initializers/constants'
   4 import { JobQueue } from '@server/lib/job-queue'
   5 import {
   6   isStreamingPlaylist,
   7   MStreamingPlaylistVideo,
   8   MVideo,
   9   MVideoAccountLightBlacklistAllFiles,
  10   MVideoFile,
  11   MVideoFullLight,
  12   MVideoIdThumbnail,
  13   MVideoImmutable,
  14   MVideoThumbnail,
  15   MVideoWithRights
  16 } from '@server/types/models'
  17 import { VideoPrivacy, VideoState, VideoTranscodingPayload } from '@shared/models'
  18 import { VideoModel } from '../models/video/video'
  19
  20 type VideoFetchType = 'all' | 'only-video' | 'only-video-with-rights' | 'id' | 'none' | 'only-immutable-attributes'
  21
  22 function fetchVideo (id: number | string, fetchType: 'all', userId?: number): Promise<MVideoFullLight>
  23 function fetchVideo (id: number | string, fetchType: 'only-immutable-attributes'): Promise<MVideoImmutable>
  24 function fetchVideo (id: number | string, fetchType: 'only-video', userId?: number): Promise<MVideoThumbnail>
  25 function fetchVideo (id: number | string, fetchType: 'only-video-with-rights', userId?: number): Promise<MVideoWithRights>
  26 function fetchVideo (id: number | string, fetchType: 'id' | 'none', userId?: number): Promise<MVideoIdThumbnail>
  27 function fetchVideo (
  28   id: number | string,
  29   fetchType: VideoFetchType,
  30   userId?: number
  31 ): Promise<MVideoFullLight | MVideoThumbnail | MVideoWithRights | MVideoIdThumbnail | MVideoImmutable>
  32 function fetchVideo (
  33   id: number | string,
  34   fetchType: VideoFetchType,
  35   userId?: number
  36 ): Promise<MVideoFullLight | MVideoThumbnail | MVideoWithRights | MVideoIdThumbnail | MVideoImmutable> {
  37   if (fetchType === 'all') return VideoModel.loadAndPopulateAccountAndServerAndTags(id, undefined, userId)
  38
  39   if (fetchType === 'only-immutable-attributes') return VideoModel.loadImmutableAttributes(id)
  40
  41   if (fetchType === 'only-video-with-rights') return VideoModel.loadWithRights(id)
  42
  43   if (fetchType === 'only-video') return VideoModel.load(id)
  44
  45   if (fetchType === 'id' || fetchType === 'none') return VideoModel.loadOnlyId(id)
  46 }
  47
  48 type VideoFetchByUrlType = 'all' | 'only-video' | 'only-immutable-attributes'
  49
  50 function fetchVideoByUrl (url: string, fetchType: 'all'): Promise<MVideoAccountLightBlacklistAllFiles>
  51 function fetchVideoByUrl (url: string, fetchType: 'only-immutable-attributes'): Promise<MVideoImmutable>
  52 function fetchVideoByUrl (url: string, fetchType: 'only-video'): Promise<MVideoThumbnail>
  53 function fetchVideoByUrl (
  54   url: string,
  55   fetchType: VideoFetchByUrlType
  56 ): Promise<MVideoAccountLightBlacklistAllFiles | MVideoThumbnail | MVideoImmutable>
  57 function fetchVideoByUrl (
  58   url: string,
  59   fetchType: VideoFetchByUrlType
  60 ): Promise<MVideoAccountLightBlacklistAllFiles | MVideoThumbnail | MVideoImmutable> {
  61   if (fetchType === 'all') return VideoModel.loadByUrlAndPopulateAccount(url)
  62
  63   if (fetchType === 'only-immutable-attributes') return VideoModel.loadByUrlImmutableAttributes(url)
  64
  65   if (fetchType === 'only-video') return VideoModel.loadByUrl(url)
  66 }
  67
  68 function getVideoWithAttributes (res: Response) {
  69   return res.locals.videoAll || res.locals.onlyVideo || res.locals.onlyVideoWithRights
  70 }
  71
  72 function addOptimizeOrMergeAudioJob (video: MVideo, videoFile: MVideoFile) {
  73   let dataInput: VideoTranscodingPayload
  74
  75   if (videoFile.isAudio()) {
  76     dataInput = {
  77       type: 'merge-audio' as 'merge-audio',
  78       resolution: DEFAULT_AUDIO_RESOLUTION,
  79       videoUUID: video.uuid,
  80       isNewVideo: true
  81     }
  82   } else {
  83     dataInput = {
  84       type: 'optimize' as 'optimize',
  85       videoUUID: video.uuid,
  86       isNewVideo: true
  87     }
  88   }
  89
  90   return JobQueue.Instance.createJobWithPromise({ type: 'video-transcoding', payload: dataInput })
  91 }
  92
  93 function extractVideo (videoOrPlaylist: MVideo | MStreamingPlaylistVideo) {
  94   return isStreamingPlaylist(videoOrPlaylist)
  95     ? videoOrPlaylist.Video
  96     : videoOrPlaylist
  97 }
  98
  99 function isPrivacyForFederation (privacy: VideoPrivacy) {
 100   const castedPrivacy = parseInt(privacy + '', 10)
 101
 102   return castedPrivacy === VideoPrivacy.PUBLIC ||
 103     (CONFIG.FEDERATION.VIDEOS.FEDERATE_UNLISTED === true && castedPrivacy === VideoPrivacy.UNLISTED)
 104 }
 105
 106 function isStateForFederation (state: VideoState) {
 107   const castedState = parseInt(state + '', 10)
 108
 109   return castedState === VideoState.PUBLISHED || castedState === VideoState.WAITING_FOR_LIVE || castedState === VideoState.LIVE_ENDED
 110
 111 }
 112
 113 function getPrivaciesForFederation () {
 114   return (CONFIG.FEDERATION.VIDEOS.FEDERATE_UNLISTED === true)
 115     ? [ { privacy: VideoPrivacy.PUBLIC }, { privacy: VideoPrivacy.UNLISTED } ]
 116     : [ { privacy: VideoPrivacy.PUBLIC } ]
 117 }
 118
 119 function getExtFromMimetype (mimeTypes: { [id: string]: string | string[] }, mimeType: string) {
 120   const value = mimeTypes[mimeType]
 121
 122   if (Array.isArray(value)) return value[0]
 123
 124   return value
 125 }
 126
 127 export {
 128   VideoFetchType,
 129   VideoFetchByUrlType,
 130   fetchVideo,
 131   getVideoWithAttributes,
 132   fetchVideoByUrl,
 133   addOptimizeOrMergeAudioJob,
 134   extractVideo,
 135   getExtFromMimetype,
 136   isStateForFederation,
 137   isPrivacyForFederation,
 138   getPrivaciesForFederation
 139 }