Handle .srt subtitles

14 files changed, 193 insertions, 37 deletions

diff --git a/server/controllers/api/videos/captions.ts b/server/controllers/api/videos/captions.ts
index 05412a17f..4cf8de1ef 100644
--- a/server/controllers/api/videos/captions.ts
+++ b/server/controllers/api/videos/captions.ts
@@ -9,11 +9,10 @@ import { createReqFiles } from '../../../helpers/express-utils'
 import { CONFIG, sequelizeTypescript, VIDEO_CAPTIONS_MIMETYPE_EXT } from '../../../initializers'
 import { getFormattedObjects } from '../../../helpers/utils'
 import { VideoCaptionModel } from '../../../models/video/video-caption'
-import { renamePromise } from '../../../helpers/core-utils'
-import { join } from 'path'
 import { VideoModel } from '../../../models/video/video'
 import { logger } from '../../../helpers/logger'
 import { federateVideoIfNeeded } from '../../../lib/activitypub'
+import { moveAndProcessCaptionFile } from '../../../helpers/captions-utils'
 
 const reqVideoCaptionAdd = createReqFiles(
   [ 'captionfile' ],
@@ -66,12 +65,7 @@ async function addVideoCaption (req: express.Request, res: express.Response) {
   videoCaption.Video = video
 
   // Move physical file
-  const videoCaptionsDir = CONFIG.STORAGE.CAPTIONS_DIR
-  const destination = join(videoCaptionsDir, videoCaption.getCaptionName())
-  await renamePromise(videoCaptionPhysicalFile.path, destination)
-  // This is important in case if there is another attempt in the retry process
-  videoCaptionPhysicalFile.filename = videoCaption.getCaptionName()
-  videoCaptionPhysicalFile.path = destination
+  await moveAndProcessCaptionFile(videoCaptionPhysicalFile, videoCaption)
 
   await sequelizeTypescript.transaction(async t => {
     await VideoCaptionModel.insertOrReplaceLanguage(video.id, req.params.captionLanguage, t)
diff --git a/server/helpers/captions-utils.ts b/server/helpers/captions-utils.ts
new file mode 100644
index 000000000..8b04f878d
--- /dev/null
+++ b/server/helpers/captions-utils.ts
@@ -0,0 +1,47 @@
+import { renamePromise, unlinkPromise } from './core-utils'
+import { join } from 'path'
+import { CONFIG } from '../initializers'
+import { VideoCaptionModel } from '../models/video/video-caption'
+import * as srt2vtt from 'srt-to-vtt'
+import { createReadStream, createWriteStream } from 'fs'
+
+async function moveAndProcessCaptionFile (physicalFile: { filename: string, path: string }, videoCaption: VideoCaptionModel) {
+  const videoCaptionsDir = CONFIG.STORAGE.CAPTIONS_DIR
+  const destination = join(videoCaptionsDir, videoCaption.getCaptionName())
+
+  // Convert this srt file to vtt
+  if (physicalFile.path.endsWith('.srt')) {
+    await convertSrtToVtt(physicalFile.path, destination)
+    await unlinkPromise(physicalFile.path)
+  } else { // Just move the vtt file
+    await renamePromise(physicalFile.path, destination)
+  }
+
+  // This is important in case if there is another attempt in the retry process
+  physicalFile.filename = videoCaption.getCaptionName()
+  physicalFile.path = destination
+}
+
+// ---------------------------------------------------------------------------
+
+export {
+  moveAndProcessCaptionFile
+}
+
+// ---------------------------------------------------------------------------
+
+function convertSrtToVtt (source: string, destination: string) {
+  return new Promise((res, rej) => {
+    const file = createReadStream(source)
+    const converter = srt2vtt()
+    const writer = createWriteStream(destination)
+
+    for (const s of [ file, converter, writer ]) {
+      s.on('error', err => rej(err))
+    }
+
+    return file.pipe(converter)
+               .pipe(writer)
+               .on('finish', () => res())
+  })
+}
diff --git a/server/helpers/custom-validators/video-captions.ts b/server/helpers/custom-validators/video-captions.ts
index fd4dc740b..6a9c6d75c 100644
--- a/server/helpers/custom-validators/video-captions.ts
+++ b/server/helpers/custom-validators/video-captions.ts
@@ -1,4 +1,4 @@
-import { CONSTRAINTS_FIELDS, VIDEO_LANGUAGES } from '../../initializers'
+import { CONSTRAINTS_FIELDS, VIDEO_CAPTIONS_MIMETYPE_EXT, VIDEO_LANGUAGES, VIDEO_MIMETYPE_EXT } from '../../initializers'
 import { exists, isFileValid } from './misc'
 import { Response } from 'express'
 import { VideoModel } from '../../models/video/video'
@@ -8,13 +8,10 @@ function isVideoCaptionLanguageValid (value: any) {
   return exists(value) && VIDEO_LANGUAGES[ value ] !== undefined
 }
 
-const videoCaptionTypes = CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.EXTNAME
-                                          .map(v => v.replace('.', ''))
-                                          .join('|')
-const videoCaptionsTypesRegex = `text/(${videoCaptionTypes})`
-
+const videoCaptionTypes = Object.keys(VIDEO_CAPTIONS_MIMETYPE_EXT).map(m => `(${m})`)
+const videoCaptionTypesRegex = videoCaptionTypes.join('|')
 function isVideoCaptionFile (files: { [ fieldname: string ]: Express.Multer.File[] } | Express.Multer.File[], field: string) {
-  return isFileValid(files, videoCaptionsTypesRegex, field, CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max)
+  return isFileValid(files, videoCaptionTypesRegex, field, CONSTRAINTS_FIELDS.VIDEO_CAPTIONS.CAPTION_FILE.FILE_SIZE.max)
 }
 
 async function isVideoCaptionExist (video: VideoModel, language: string, res: Response) {
diff --git a/server/initializers/constants.ts b/server/initializers/constants.ts
index 49809e64c..3837f7062 100644
--- a/server/initializers/constants.ts
+++ b/server/initializers/constants.ts
@@ -231,7 +231,7 @@ const CONSTRAINTS_FIELDS = {
   },
   VIDEO_CAPTIONS: {
     CAPTION_FILE: {
-      EXTNAME: [ '.vtt' ],
+      EXTNAME: [ '.vtt', '.srt' ],
       FILE_SIZE: {
         max: 2 * 1024 * 1024 // 2MB
       }
@@ -364,7 +364,8 @@ const IMAGE_MIMETYPE_EXT = {
 }
 
 const VIDEO_CAPTIONS_MIMETYPE_EXT = {
-  'text/vtt': '.vtt'
+  'text/vtt': '.vtt',
+  'application/x-subrip': '.srt'
 }
 
 // ---------------------------------------------------------------------------
@@ -451,9 +452,13 @@ const EMBED_SIZE = {
 
 // Sub folders of cache directory
 const CACHE = {
-  DIRECTORIES: {
-    PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
-    VIDEO_CAPTIONS: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions')
+  PREVIEWS: {
+    DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
+    MAX_AGE: 1000 * 3600 * 3 // 3 hours
+  },
+  VIDEO_CAPTIONS: {
+    DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
+    MAX_AGE: 1000 * 3600 * 3 // 3 hours
   }
 }
 
@@ -500,6 +505,8 @@ if (isTestInstance() === true) {
   VIDEO_VIEW_LIFETIME = 1000 // 1 second
 
   JOB_ATTEMPTS['email'] = 1
+
+  CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
 }
 
 updateWebserverConfig()
diff --git a/server/initializers/installer.ts b/server/initializers/installer.ts
index b0084b368..1f513a9c3 100644
--- a/server/initializers/installer.ts
+++ b/server/initializers/installer.ts
@@ -33,7 +33,8 @@ export {
 // ---------------------------------------------------------------------------
 
 function removeCacheDirectories () {
-  const cacheDirectories = CACHE.DIRECTORIES
+  const cacheDirectories = Object.keys(CACHE)
+    .map(k => CACHE[k].DIRECTORY)
 
   const tasks: Promise<any>[] = []
 
@@ -48,7 +49,8 @@ function removeCacheDirectories () {
 
 function createDirectoriesIfNotExist () {
   const storage = CONFIG.STORAGE
-  const cacheDirectories = CACHE.DIRECTORIES
+  const cacheDirectories = Object.keys(CACHE)
+                                 .map(k => CACHE[k].DIRECTORY)
 
   const tasks = []
   for (const key of Object.keys(storage)) {
diff --git a/server/lib/cache/abstract-video-static-file-cache.ts b/server/lib/cache/abstract-video-static-file-cache.ts
index 7eeeb6b3a..8e895cc82 100644
--- a/server/lib/cache/abstract-video-static-file-cache.ts
+++ b/server/lib/cache/abstract-video-static-file-cache.ts
@@ -1,12 +1,9 @@
 import * as AsyncLRU from 'async-lru'
 import { createWriteStream } from 'fs'
-import { join } from 'path'
 import { unlinkPromise } from '../../helpers/core-utils'
 import { logger } from '../../helpers/logger'
-import { CACHE, CONFIG } from '../../initializers'
 import { VideoModel } from '../../models/video/video'
 import { fetchRemoteVideoStaticFile } from '../activitypub'
-import { VideoCaptionModel } from '../../models/video/video-caption'
 
 export abstract class AbstractVideoStaticFileCache <T> {
 
@@ -17,9 +14,10 @@ export abstract class AbstractVideoStaticFileCache <T> {
   // Load and save the remote file, then return the local path from filesystem
   protected abstract loadRemoteFile (key: string): Promise<string>
 
-  init (max: number) {
+  init (max: number, maxAge: number) {
     this.lru = new AsyncLRU({
       max,
+      maxAge,
       load: (key, cb) => {
         this.loadRemoteFile(key)
           .then(res => cb(null, res))
@@ -28,7 +26,8 @@ export abstract class AbstractVideoStaticFileCache <T> {
     })
 
     this.lru.on('evict', (obj: { key: string, value: string }) => {
-      unlinkPromise(obj.value).then(() => logger.debug('%s evicted from %s', obj.value, this.constructor.name))
+      unlinkPromise(obj.value)
+        .then(() => logger.debug('%s evicted from %s', obj.value, this.constructor.name))
     })
   }
 
diff --git a/server/lib/cache/videos-caption-cache.ts b/server/lib/cache/videos-caption-cache.ts
index 1336610b2..380d42b2c 100644
--- a/server/lib/cache/videos-caption-cache.ts
+++ b/server/lib/cache/videos-caption-cache.ts
@@ -42,7 +42,7 @@ class VideosCaptionCache extends AbstractVideoStaticFileCache <GetPathParam> {
     if (!video) return undefined
 
     const remoteStaticPath = videoCaption.getCaptionStaticPath()
-    const destPath = join(CACHE.DIRECTORIES.VIDEO_CAPTIONS, videoCaption.getCaptionName())
+    const destPath = join(CACHE.VIDEO_CAPTIONS.DIRECTORY, videoCaption.getCaptionName())
 
     return this.saveRemoteVideoFileAndReturnPath(video, remoteStaticPath, destPath)
   }
diff --git a/server/lib/cache/videos-preview-cache.ts b/server/lib/cache/videos-preview-cache.ts
index 1c0e7ed9d..22b6d9cb0 100644
--- a/server/lib/cache/videos-preview-cache.ts
+++ b/server/lib/cache/videos-preview-cache.ts
@@ -31,7 +31,7 @@ class VideosPreviewCache extends AbstractVideoStaticFileCache <string> {
     if (video.isOwned()) throw new Error('Cannot load remote preview of owned video.')
 
     const remoteStaticPath = join(STATIC_PATHS.PREVIEWS, video.getPreviewName())
-    const destPath = join(CACHE.DIRECTORIES.PREVIEWS, video.getPreviewName())
+    const destPath = join(CACHE.PREVIEWS.DIRECTORY, video.getPreviewName())
 
     return this.saveRemoteVideoFileAndReturnPath(video, remoteStaticPath, destPath)
   }
diff --git a/server/models/video/video-caption.ts b/server/models/video/video-caption.ts
index 9920dfc7c..5a1becc47 100644
--- a/server/models/video/video-caption.ts
+++ b/server/models/video/video-caption.ts
@@ -75,14 +75,18 @@ export class VideoCaptionModel extends Model<VideoCaptionModel> {
 
   @BeforeDestroy
   static async removeFiles (instance: VideoCaptionModel) {
+    if (!instance.Video) {
+      instance.Video = await instance.$get('Video') as VideoModel
+    }
 
     if (instance.isOwned()) {
-      if (!instance.Video) {
-        instance.Video = await instance.$get('Video') as VideoModel
-      }
-
       logger.debug('Removing captions %s of video %s.', instance.Video.uuid, instance.language)
-      return instance.removeCaptionFile()
+
+      try {
+        await instance.removeCaptionFile()
+      } catch (err) {
+        logger.error('Cannot remove caption file of video %s.', instance.Video.uuid)
+      }
     }
 
     return undefined
diff --git a/server/tests/api/check-params/video-captions.ts b/server/tests/api/check-params/video-captions.ts
index 12f890db8..a3d7ac35d 100644
--- a/server/tests/api/check-params/video-captions.ts
+++ b/server/tests/api/check-params/video-captions.ts
@@ -1,6 +1,5 @@
 /* tslint:disable:no-unused-expression */
 
-import * as chai from 'chai'
 import 'mocha'
 import {
   createUser,
@@ -127,6 +126,40 @@ describe('Test video captions API validator', function () {
       })
     })
 
+    it('Should fail with an invalid captionfile extension', async function () {
+      const attaches = {
+        'captionfile': join(__dirname, '..', '..', 'fixtures', 'subtitle-bad.txt')
+      }
+
+      const captionPath = path + videoUUID + '/captions/fr'
+      await makeUploadRequest({
+        method: 'PUT',
+        url: server.url,
+        path: captionPath,
+        token: server.accessToken,
+        fields,
+        attaches,
+        statusCodeExpected: 400
+      })
+    })
+
+    // it('Should fail with an invalid captionfile srt', async function () {
+    //   const attaches = {
+    //     'captionfile': join(__dirname, '..', '..', 'fixtures', 'subtitle-bad.srt')
+    //   }
+    //
+    //   const captionPath = path + videoUUID + '/captions/fr'
+    //   await makeUploadRequest({
+    //     method: 'PUT',
+    //     url: server.url,
+    //     path: captionPath,
+    //     token: server.accessToken,
+    //     fields,
+    //     attaches,
+    //     statusCodeExpected: 500
+    //   })
+    // })
+
     it('Should success with the correct parameters', async function () {
       const captionPath = path + videoUUID + '/captions/fr'
       await makeUploadRequest({
diff --git a/server/tests/api/videos/video-captions.ts b/server/tests/api/videos/video-captions.ts
index cbf5268f0..eb73c5baf 100644
--- a/server/tests/api/videos/video-captions.ts
+++ b/server/tests/api/videos/video-captions.ts
@@ -2,7 +2,7 @@
 
 import * as chai from 'chai'
 import 'mocha'
-import { doubleFollow, flushAndRunMultipleServers, uploadVideo } from '../../utils'
+import { checkVideoFilesWereRemoved, doubleFollow, flushAndRunMultipleServers, removeVideo, uploadVideo, wait } from '../../utils'
 import { flushTests, killallServers, ServerInfo, setAccessTokensToServers } from '../../utils/index'
 import { waitJobs } from '../../utils/server/jobs'
 import { createVideoCaption, deleteVideoCaption, listVideoCaptions, testCaptionFile } from '../../utils/videos/video-captions'
@@ -110,6 +110,51 @@ describe('Test video captions', function () {
     }
   })
 
+  it('Should replace an existing caption with a srt file and convert it', async function () {
+    this.timeout(30000)
+
+    await createVideoCaption({
+      url: servers[0].url,
+      accessToken: servers[0].accessToken,
+      language: 'ar',
+      videoId: videoUUID,
+      fixture: 'subtitle-good.srt'
+    })
+
+    await waitJobs(servers)
+
+    // Cache invalidation
+    await wait(3000)
+  })
+
+  it('Should have this caption updated and converted', async function () {
+    for (const server of servers) {
+      const res = await listVideoCaptions(server.url, videoUUID)
+      expect(res.body.total).to.equal(2)
+      expect(res.body.data).to.have.lengthOf(2)
+
+      const caption1: VideoCaption = res.body.data[0]
+      expect(caption1.language.id).to.equal('ar')
+      expect(caption1.language.label).to.equal('Arabic')
+      expect(caption1.captionPath).to.equal('/static/video-captions/' + videoUUID + '-ar.vtt')
+
+      const expected = 'WEBVTT FILE\r\n' +
+        '\r\n' +
+        '1\r\n' +
+        '00:00:01.600 --> 00:00:04.200\r\n' +
+        'English (US)\r\n' +
+        '\r\n' +
+        '2\r\n' +
+        '00:00:05.900 --> 00:00:07.999\r\n' +
+        'This is a subtitle in American English\r\n' +
+        '\r\n' +
+        '3\r\n' +
+        '00:00:10.000 --> 00:00:14.000\r\n' +
+        'Adding subtitles is very easy to do\r\n'
+      await testCaptionFile(server.url, caption1.captionPath, expected)
+    }
+  })
+
   it('Should remove one caption', async function () {
     this.timeout(30000)
 
@@ -133,6 +178,12 @@ describe('Test video captions', function () {
     }
   })
 
+  it('Should remove the video, and thus all video captions', async function () {
+    await removeVideo(servers[0].url, servers[0].accessToken, videoUUID)
+
+    await checkVideoFilesWereRemoved(videoUUID, 1)
+  })
+
   after(async function () {
     killallServers(servers)
   })
diff --git a/server/tests/fixtures/subtitle-bad.txt b/server/tests/fixtures/subtitle-bad.txt
new file mode 100644
index 000000000..a2a30ae47
--- /dev/null
+++ b/server/tests/fixtures/subtitle-bad.txt
@@ -0,0 +1,11 @@
+1
+00:00:01,600 --> 00:00:04,200
+English (US)
+
+2
+00:00:05,900 --> 00:00:07,999
+This is a subtitle in American English
+
+3
+00:00:10,000 --> 00:00:14,000
+Adding subtitles is very easy to do
\ No newline at end of file
diff --git a/server/tests/fixtures/subtitle-good.srt b/server/tests/fixtures/subtitle-good.srt
new file mode 100644
index 000000000..a2a30ae47
--- /dev/null
+++ b/server/tests/fixtures/subtitle-good.srt
@@ -0,0 +1,11 @@
+1
+00:00:01,600 --> 00:00:04,200
+English (US)
+
+2
+00:00:05,900 --> 00:00:07,999
+This is a subtitle in American English
+
+3
+00:00:10,000 --> 00:00:14,000
+Adding subtitles is very easy to do
\ No newline at end of file
diff --git a/server/tests/utils/videos/videos.ts b/server/tests/utils/videos/videos.ts
index 4f7ce6d6b..74bf7354e 100644
--- a/server/tests/utils/videos/videos.ts
+++ b/server/tests/utils/videos/videos.ts
@@ -301,7 +301,7 @@ function searchVideoWithSort (url: string, search: string, sort: string) {
 async function checkVideoFilesWereRemoved (videoUUID: string, serverNumber: number) {
   const testDirectory = 'test' + serverNumber
 
-  for (const directory of [ 'videos', 'thumbnails', 'torrents', 'previews' ]) {
+  for (const directory of [ 'videos', 'thumbnails', 'torrents', 'previews', 'captions' ]) {
     const directoryPath = join(root(), testDirectory, directory)
 
     const directoryExists = existsSync(directoryPath)