Merge branch 'release/v1.3.0' into develop
[oweals/peertube.git] / server / lib / files-cache / videos-caption-cache.ts
1 import { join } from 'path'
2 import { FILES_CACHE } from '../../initializers/constants'
3 import { VideoModel } from '../../models/video/video'
4 import { VideoCaptionModel } from '../../models/video/video-caption'
5 import { AbstractVideoStaticFileCache } from './abstract-video-static-file-cache'
6 import { CONFIG } from '../../initializers/config'
7 import { logger } from '../../helpers/logger'
8 import { fetchRemoteVideoStaticFile } from '../activitypub'
9
10 type GetPathParam = { videoId: string, language: string }
11
12 class VideosCaptionCache extends AbstractVideoStaticFileCache <GetPathParam> {
13
14   private static readonly KEY_DELIMITER = '%'
15   private static instance: VideosCaptionCache
16
17   private constructor () {
18     super()
19   }
20
21   static get Instance () {
22     return this.instance || (this.instance = new this())
23   }
24
25   async getFilePathImpl (params: GetPathParam) {
26     const videoCaption = await VideoCaptionModel.loadByVideoIdAndLanguage(params.videoId, params.language)
27     if (!videoCaption) return undefined
28
29     if (videoCaption.isOwned()) return { isOwned: true, path: join(CONFIG.STORAGE.CAPTIONS_DIR, videoCaption.getCaptionName()) }
30
31     const key = params.videoId + VideosCaptionCache.KEY_DELIMITER + params.language
32     return this.loadRemoteFile(key)
33   }
34
35   protected async loadRemoteFile (key: string) {
36     logger.debug('Loading remote caption file %s.', key)
37
38     const [ videoId, language ] = key.split(VideosCaptionCache.KEY_DELIMITER)
39
40     const videoCaption = await VideoCaptionModel.loadByVideoIdAndLanguage(videoId, language)
41     if (!videoCaption) return undefined
42
43     if (videoCaption.isOwned()) throw new Error('Cannot load remote caption of owned video.')
44
45     // Used to fetch the path
46     const video = await VideoModel.loadAndPopulateAccountAndServerAndTags(videoId)
47     if (!video) return undefined
48
49     // FIXME: use URL
50     const remoteStaticPath = videoCaption.getCaptionStaticPath()
51     const destPath = join(FILES_CACHE.VIDEO_CAPTIONS.DIRECTORY, videoCaption.getCaptionName())
52
53     await fetchRemoteVideoStaticFile(video, remoteStaticPath, destPath)
54
55     return { isOwned: false, path: destPath }
56   }
57 }
58
59 export {
60   VideosCaptionCache
61 }