Remove previous thumbnail if needed

6 files changed, 196 insertions, 96 deletions

diff --git a/server/lib/activitypub/playlist.ts b/server/lib/activitypub/playlist.ts
index 53298e968..d5a3ef7c8 100644
--- a/server/lib/activitypub/playlist.ts
+++ b/server/lib/activitypub/playlist.ts
@@ -103,7 +103,7 @@ async function createOrUpdateVideoPlaylist (playlistObject: PlaylistObject, byAc
 
   if (playlistObject.icon) {
     try {
-      const thumbnailModel = await createPlaylistMiniatureFromUrl(playlistObject.icon.url, refreshedPlaylist)
+      const thumbnailModel = await createPlaylistMiniatureFromUrl({ downloadUrl: playlistObject.icon.url, playlist: refreshedPlaylist })
       await refreshedPlaylist.setAndSaveThumbnail(thumbnailModel, undefined)
     } catch (err) {
       logger.warn('Cannot generate thumbnail of %s.', playlistObject.id, { err })
diff --git a/server/lib/activitypub/videos.ts b/server/lib/activitypub/videos.ts
index 201ef0302..66981f43f 100644
--- a/server/lib/activitypub/videos.ts
+++ b/server/lib/activitypub/videos.ts
@@ -313,7 +313,11 @@ async function updateVideoFromAP (options: {
     let thumbnailModel: MThumbnail
 
     try {
-      thumbnailModel = await createVideoMiniatureFromUrl(getThumbnailFromIcons(videoObject).url, video, ThumbnailType.MINIATURE)
+      thumbnailModel = await createVideoMiniatureFromUrl({
+        downloadUrl: getThumbnailFromIcons(videoObject).url,
+        video,
+        type: ThumbnailType.MINIATURE
+      })
     } catch (err) {
       logger.warn('Cannot generate thumbnail of %s.', videoObject.id, { err })
     }
@@ -362,7 +366,12 @@ async function updateVideoFromAP (options: {
 
       if (videoUpdated.getPreview()) {
         const previewUrl = getPreviewUrl(getPreviewFromIcons(videoObject), video)
-        const previewModel = createPlaceholderThumbnail(previewUrl, video, ThumbnailType.PREVIEW, PREVIEWS_SIZE)
+        const previewModel = createPlaceholderThumbnail({
+          fileUrl: previewUrl,
+          video,
+          type: ThumbnailType.PREVIEW,
+          size: PREVIEWS_SIZE
+        })
         await videoUpdated.addAndSaveThumbnail(previewModel, t)
       }
 
@@ -585,11 +594,14 @@ async function createVideo (videoObject: VideoObject, channel: MChannelAccountLi
   const videoData = await videoActivityObjectToDBAttributes(channel, videoObject, videoObject.to)
   const video = VideoModel.build(videoData) as MVideoThumbnail
 
-  const promiseThumbnail = createVideoMiniatureFromUrl(getThumbnailFromIcons(videoObject).url, video, ThumbnailType.MINIATURE)
-    .catch(err => {
-      logger.error('Cannot create miniature from url.', { err })
-      return undefined
-    })
+  const promiseThumbnail = createVideoMiniatureFromUrl({
+    downloadUrl: getThumbnailFromIcons(videoObject).url,
+    video,
+    type: ThumbnailType.MINIATURE
+  }).catch(err => {
+    logger.error('Cannot create miniature from url.', { err })
+    return undefined
+  })
 
   let thumbnailModel: MThumbnail
   if (waitThumbnail === true) {
@@ -597,81 +609,93 @@ async function createVideo (videoObject: VideoObject, channel: MChannelAccountLi
   }
 
   const { autoBlacklisted, videoCreated } = await sequelizeTypescript.transaction(async t => {
-    const sequelizeOptions = { transaction: t }
+    try {
+      const sequelizeOptions = { transaction: t }
 
-    const videoCreated = await video.save(sequelizeOptions) as MVideoFullLight
-    videoCreated.VideoChannel = channel
+      const videoCreated = await video.save(sequelizeOptions) as MVideoFullLight
+      videoCreated.VideoChannel = channel
 
-    if (thumbnailModel) await videoCreated.addAndSaveThumbnail(thumbnailModel, t)
+      if (thumbnailModel) await videoCreated.addAndSaveThumbnail(thumbnailModel, t)
 
-    const previewIcon = getPreviewFromIcons(videoObject)
-    const previewUrl = getPreviewUrl(previewIcon, videoCreated)
-    const previewModel = createPlaceholderThumbnail(previewUrl, videoCreated, ThumbnailType.PREVIEW, PREVIEWS_SIZE)
+      const previewUrl = getPreviewUrl(getPreviewFromIcons(videoObject), videoCreated)
+      const previewModel = createPlaceholderThumbnail({
+        fileUrl: previewUrl,
+        video: videoCreated,
+        type: ThumbnailType.PREVIEW,
+        size: PREVIEWS_SIZE
+      })
 
-    if (thumbnailModel) await videoCreated.addAndSaveThumbnail(previewModel, t)
+      if (thumbnailModel) await videoCreated.addAndSaveThumbnail(previewModel, t)
 
-    // Process files
-    const videoFileAttributes = videoFileActivityUrlToDBAttributes(videoCreated, videoObject.url)
+      // Process files
+      const videoFileAttributes = videoFileActivityUrlToDBAttributes(videoCreated, videoObject.url)
 
-    const videoFilePromises = videoFileAttributes.map(f => VideoFileModel.create(f, { transaction: t }))
-    const videoFiles = await Promise.all(videoFilePromises)
+      const videoFilePromises = videoFileAttributes.map(f => VideoFileModel.create(f, { transaction: t }))
+      const videoFiles = await Promise.all(videoFilePromises)
 
-    const streamingPlaylistsAttributes = streamingPlaylistActivityUrlToDBAttributes(videoCreated, videoObject, videoFiles)
-    videoCreated.VideoStreamingPlaylists = []
+      const streamingPlaylistsAttributes = streamingPlaylistActivityUrlToDBAttributes(videoCreated, videoObject, videoFiles)
+      videoCreated.VideoStreamingPlaylists = []
 
-    for (const playlistAttributes of streamingPlaylistsAttributes) {
-      const playlistModel = await VideoStreamingPlaylistModel.create(playlistAttributes, { transaction: t })
+      for (const playlistAttributes of streamingPlaylistsAttributes) {
+        const playlistModel = await VideoStreamingPlaylistModel.create(playlistAttributes, { transaction: t })
 
-      const playlistFiles = videoFileActivityUrlToDBAttributes(playlistModel, playlistAttributes.tagAPObject)
-      const videoFilePromises = playlistFiles.map(f => VideoFileModel.create(f, { transaction: t }))
-      playlistModel.VideoFiles = await Promise.all(videoFilePromises)
+        const playlistFiles = videoFileActivityUrlToDBAttributes(playlistModel, playlistAttributes.tagAPObject)
+        const videoFilePromises = playlistFiles.map(f => VideoFileModel.create(f, { transaction: t }))
+        playlistModel.VideoFiles = await Promise.all(videoFilePromises)
 
-      videoCreated.VideoStreamingPlaylists.push(playlistModel)
-    }
+        videoCreated.VideoStreamingPlaylists.push(playlistModel)
+      }
 
-    // Process tags
-    const tags = videoObject.tag
-                            .filter(isAPHashTagObject)
-                            .map(t => t.name)
-    await setVideoTags({ video: videoCreated, tags, transaction: t })
-
-    // Process captions
-    const videoCaptionsPromises = videoObject.subtitleLanguage.map(c => {
-      const caption = new VideoCaptionModel({
-        videoId: videoCreated.id,
-        filename: VideoCaptionModel.generateCaptionName(c.identifier),
-        language: c.identifier,
-        fileUrl: c.url
-      }) as MVideoCaption
-
-      return VideoCaptionModel.insertOrReplaceLanguage(caption, t)
-    })
-    await Promise.all(videoCaptionsPromises)
+      // Process tags
+      const tags = videoObject.tag
+                              .filter(isAPHashTagObject)
+                              .map(t => t.name)
+      await setVideoTags({ video: videoCreated, tags, transaction: t })
+
+      // Process captions
+      const videoCaptionsPromises = videoObject.subtitleLanguage.map(c => {
+        const caption = new VideoCaptionModel({
+          videoId: videoCreated.id,
+          filename: VideoCaptionModel.generateCaptionName(c.identifier),
+          language: c.identifier,
+          fileUrl: c.url
+        }) as MVideoCaption
+
+        return VideoCaptionModel.insertOrReplaceLanguage(caption, t)
+      })
+      await Promise.all(videoCaptionsPromises)
 
-    videoCreated.VideoFiles = videoFiles
+      videoCreated.VideoFiles = videoFiles
 
-    if (videoCreated.isLive) {
-      const videoLive = new VideoLiveModel({
-        streamKey: null,
-        saveReplay: videoObject.liveSaveReplay,
-        permanentLive: videoObject.permanentLive,
-        videoId: videoCreated.id
-      })
+      if (videoCreated.isLive) {
+        const videoLive = new VideoLiveModel({
+          streamKey: null,
+          saveReplay: videoObject.liveSaveReplay,
+          permanentLive: videoObject.permanentLive,
+          videoId: videoCreated.id
+        })
 
-      videoCreated.VideoLive = await videoLive.save({ transaction: t })
-    }
+        videoCreated.VideoLive = await videoLive.save({ transaction: t })
+      }
 
-    const autoBlacklisted = await autoBlacklistVideoIfNeeded({
-      video: videoCreated,
-      user: undefined,
-      isRemote: true,
-      isNew: true,
-      transaction: t
-    })
+      const autoBlacklisted = await autoBlacklistVideoIfNeeded({
+        video: videoCreated,
+        user: undefined,
+        isRemote: true,
+        isNew: true,
+        transaction: t
+      })
 
-    logger.info('Remote video with uuid %s inserted.', videoObject.uuid)
+      logger.info('Remote video with uuid %s inserted.', videoObject.uuid)
 
-    return { autoBlacklisted, videoCreated }
+      return { autoBlacklisted, videoCreated }
+    } catch (err) {
+      // FIXME: Use rollback hook when https://github.com/sequelize/sequelize/pull/13038 is released
+      // Remove thumbnail
+      if (thumbnailModel) await thumbnailModel.removeThumbnail()
+
+      throw err
+    }
   })
 
   if (waitThumbnail === false) {
diff --git a/server/lib/files-cache/videos-preview-cache.ts b/server/lib/files-cache/videos-preview-cache.ts
index 47488da74..ee72cd3f9 100644
--- a/server/lib/files-cache/videos-preview-cache.ts
+++ b/server/lib/files-cache/videos-preview-cache.ts
@@ -20,7 +20,7 @@ class VideosPreviewCache extends AbstractVideoStaticFileCache <string> {
   }
 
   async getFilePathImpl (filename: string) {
-    const thumbnail = await ThumbnailModel.loadWithVideoByName(filename, ThumbnailType.PREVIEW)
+    const thumbnail = await ThumbnailModel.loadWithVideoByFilename(filename, ThumbnailType.PREVIEW)
     if (!thumbnail) return undefined
 
     if (thumbnail.Video.isOwned()) return { isOwned: true, path: thumbnail.getPath() }
diff --git a/server/lib/job-queue/handlers/video-import.ts b/server/lib/job-queue/handlers/video-import.ts
index 1e5e52b58..0d00c1b9d 100644
--- a/server/lib/job-queue/handlers/video-import.ts
+++ b/server/lib/job-queue/handlers/video-import.ts
@@ -162,7 +162,11 @@ async function processFile (downloader: () => Promise<string>, videoImport: MVid
     let thumbnailModel: MThumbnail
     let thumbnailSave: object
     if (!videoImportWithFiles.Video.getMiniature()) {
-      thumbnailModel = await generateVideoMiniature(videoImportWithFiles.Video, videoFile, ThumbnailType.MINIATURE)
+      thumbnailModel = await generateVideoMiniature({
+        video: videoImportWithFiles.Video,
+        videoFile,
+        type: ThumbnailType.MINIATURE
+      })
       thumbnailSave = thumbnailModel.toJSON()
     }
 
@@ -170,7 +174,11 @@ async function processFile (downloader: () => Promise<string>, videoImport: MVid
     let previewModel: MThumbnail
     let previewSave: object
     if (!videoImportWithFiles.Video.getPreview()) {
-      previewModel = await generateVideoMiniature(videoImportWithFiles.Video, videoFile, ThumbnailType.PREVIEW)
+      previewModel = await generateVideoMiniature({
+        video: videoImportWithFiles.Video,
+        videoFile,
+        type: ThumbnailType.PREVIEW
+      })
       previewSave = previewModel.toJSON()
     }
 
diff --git a/server/lib/job-queue/handlers/video-live-ending.ts b/server/lib/job-queue/handlers/video-live-ending.ts
index db6cd3682..6d50635bb 100644
--- a/server/lib/job-queue/handlers/video-live-ending.ts
+++ b/server/lib/job-queue/handlers/video-live-ending.ts
@@ -122,11 +122,19 @@ async function saveLive (video: MVideo, live: MVideoLive) {
 
   // Regenerate the thumbnail & preview?
   if (videoWithFiles.getMiniature().automaticallyGenerated === true) {
-    await generateVideoMiniature(videoWithFiles, videoWithFiles.getMaxQualityFile(), ThumbnailType.MINIATURE)
+    await generateVideoMiniature({
+      video: videoWithFiles,
+      videoFile: videoWithFiles.getMaxQualityFile(),
+      type: ThumbnailType.MINIATURE
+    })
   }
 
   if (videoWithFiles.getPreview().automaticallyGenerated === true) {
-    await generateVideoMiniature(videoWithFiles, videoWithFiles.getMaxQualityFile(), ThumbnailType.PREVIEW)
+    await generateVideoMiniature({
+      video: videoWithFiles,
+      videoFile: videoWithFiles.getMaxQualityFile(),
+      type: ThumbnailType.PREVIEW
+    })
   }
 
   await publishAndFederateIfNeeded(videoWithFiles, true)
diff --git a/server/lib/thumbnail.ts b/server/lib/thumbnail.ts
index 33aa7159c..55478299c 100644
--- a/server/lib/thumbnail.ts
+++ b/server/lib/thumbnail.ts
@@ -1,33 +1,48 @@
+import { join } from 'path'
+
+import { ThumbnailType } from '../../shared/models/videos/thumbnail.type'
 import { generateImageFromVideoFile } from '../helpers/ffmpeg-utils'
+import { processImage } from '../helpers/image-utils'
+import { downloadImage } from '../helpers/requests'
 import { CONFIG } from '../initializers/config'
 import { ASSETS_PATH, PREVIEWS_SIZE, THUMBNAILS_SIZE } from '../initializers/constants'
 import { ThumbnailModel } from '../models/video/thumbnail'
-import { ThumbnailType } from '../../shared/models/videos/thumbnail.type'
-import { processImage } from '../helpers/image-utils'
-import { join } from 'path'
-import { downloadImage } from '../helpers/requests'
-import { MVideoPlaylistThumbnail } from '../types/models/video/video-playlist'
 import { MVideoFile, MVideoThumbnail } from '../types/models'
 import { MThumbnail } from '../types/models/video/thumbnail'
+import { MVideoPlaylistThumbnail } from '../types/models/video/video-playlist'
 import { getVideoFilePath } from './video-paths'
 
 type ImageSize = { height: number, width: number }
 
-function createPlaylistMiniatureFromExisting (
-  inputPath: string,
-  playlist: MVideoPlaylistThumbnail,
-  automaticallyGenerated: boolean,
-  keepOriginal = false,
+function createPlaylistMiniatureFromExisting (options: {
+  inputPath: string
+  playlist: MVideoPlaylistThumbnail
+  automaticallyGenerated: boolean
+  keepOriginal?: boolean // default to false
   size?: ImageSize
-) {
+}) {
+  const { inputPath, playlist, automaticallyGenerated, keepOriginal = false, size } = options
   const { filename, outputPath, height, width, existingThumbnail } = buildMetadataFromPlaylist(playlist, size)
   const type = ThumbnailType.MINIATURE
 
   const thumbnailCreator = () => processImage(inputPath, outputPath, { width, height }, keepOriginal)
-  return createThumbnailFromFunction({ thumbnailCreator, filename, height, width, type, automaticallyGenerated, existingThumbnail })
+  return createThumbnailFromFunction({
+    thumbnailCreator,
+    filename,
+    height,
+    width,
+    type,
+    automaticallyGenerated,
+    existingThumbnail
+  })
 }
 
-function createPlaylistMiniatureFromUrl (downloadUrl: string, playlist: MVideoPlaylistThumbnail, size?: ImageSize) {
+function createPlaylistMiniatureFromUrl (options: {
+  downloadUrl: string
+  playlist: MVideoPlaylistThumbnail
+  size?: ImageSize
+}) {
+  const { downloadUrl, playlist, size } = options
   const { filename, basePath, height, width, existingThumbnail } = buildMetadataFromPlaylist(playlist, size)
   const type = ThumbnailType.MINIATURE
 
@@ -40,7 +55,13 @@ function createPlaylistMiniatureFromUrl (downloadUrl: string, playlist: MVideoPl
   return createThumbnailFromFunction({ thumbnailCreator, filename, height, width, type, existingThumbnail, fileUrl })
 }
 
-function createVideoMiniatureFromUrl (downloadUrl: string, video: MVideoThumbnail, type: ThumbnailType, size?: ImageSize) {
+function createVideoMiniatureFromUrl (options: {
+  downloadUrl: string
+  video: MVideoThumbnail
+  type: ThumbnailType
+  size?: ImageSize
+}) {
+  const { downloadUrl, video, type, size } = options
   const { filename, basePath, height, width, existingThumbnail } = buildMetadataFromVideo(video, type, size)
 
   // Only save the file URL if it is a remote video
@@ -58,17 +79,31 @@ function createVideoMiniatureFromExisting (options: {
   type: ThumbnailType
   automaticallyGenerated: boolean
   size?: ImageSize
-  keepOriginal?: boolean
+  keepOriginal?: boolean // default to false
 }) {
-  const { inputPath, video, type, automaticallyGenerated, size, keepOriginal } = options
+  const { inputPath, video, type, automaticallyGenerated, size, keepOriginal = false } = options
 
   const { filename, outputPath, height, width, existingThumbnail } = buildMetadataFromVideo(video, type, size)
   const thumbnailCreator = () => processImage(inputPath, outputPath, { width, height }, keepOriginal)
 
-  return createThumbnailFromFunction({ thumbnailCreator, filename, height, width, type, automaticallyGenerated, existingThumbnail })
+  return createThumbnailFromFunction({
+    thumbnailCreator,
+    filename,
+    height,
+    width,
+    type,
+    automaticallyGenerated,
+    existingThumbnail
+  })
 }
 
-function generateVideoMiniature (video: MVideoThumbnail, videoFile: MVideoFile, type: ThumbnailType) {
+function generateVideoMiniature (options: {
+  video: MVideoThumbnail
+  videoFile: MVideoFile
+  type: ThumbnailType
+}) {
+  const { video, videoFile, type } = options
+
   const input = getVideoFilePath(video, videoFile)
 
   const { filename, basePath, height, width, existingThumbnail, outputPath } = buildMetadataFromVideo(video, type)
@@ -76,10 +111,24 @@ function generateVideoMiniature (video: MVideoThumbnail, videoFile: MVideoFile,
     ? () => processImage(ASSETS_PATH.DEFAULT_AUDIO_BACKGROUND, outputPath, { width, height }, true)
     : () => generateImageFromVideoFile(input, basePath, filename, { height, width })
 
-  return createThumbnailFromFunction({ thumbnailCreator, filename, height, width, type, automaticallyGenerated: true, existingThumbnail })
+  return createThumbnailFromFunction({
+    thumbnailCreator,
+    filename,
+    height,
+    width,
+    type,
+    automaticallyGenerated: true,
+    existingThumbnail
+  })
 }
 
-function createPlaceholderThumbnail (fileUrl: string, video: MVideoThumbnail, type: ThumbnailType, size: ImageSize) {
+function createPlaceholderThumbnail (options: {
+  fileUrl: string
+  video: MVideoThumbnail
+  type: ThumbnailType
+  size: ImageSize
+}) {
+  const { fileUrl, video, type, size } = options
   const { filename, height, width, existingThumbnail } = buildMetadataFromVideo(video, type, size)
 
   const thumbnail = existingThumbnail || new ThumbnailModel()
@@ -164,12 +213,22 @@ async function createThumbnailFromFunction (parameters: {
   fileUrl?: string
   existingThumbnail?: MThumbnail
 }) {
-  const { thumbnailCreator, filename, width, height, type, existingThumbnail, automaticallyGenerated = null, fileUrl = null } = parameters
-
-  // Remove old file
-  if (existingThumbnail) await existingThumbnail.removeThumbnail()
+  const {
+    thumbnailCreator,
+    filename,
+    width,
+    height,
+    type,
+    existingThumbnail,
+    automaticallyGenerated = null,
+    fileUrl = null
+  } = parameters
+
+  const oldFilename = existingThumbnail
+    ? existingThumbnail.filename
+    : undefined
 
-  const thumbnail = existingThumbnail || new ThumbnailModel()
+  const thumbnail: MThumbnail = existingThumbnail || new ThumbnailModel()
 
   thumbnail.filename = filename
   thumbnail.height = height
@@ -177,6 +236,7 @@ async function createThumbnailFromFunction (parameters: {
   thumbnail.type = type
   thumbnail.fileUrl = fileUrl
   thumbnail.automaticallyGenerated = automaticallyGenerated
+  thumbnail.previousThumbnailFilename = oldFilename
 
   await thumbnailCreator()