Remove exif tags when processing images

[github/Chocobozzz/PeerTube.git] / server / helpers / image-utils.ts

diff --git a/server/helpers/image-utils.ts b/server/helpers/image-utils.ts
index 9285c12fc59aa383de2b4135b1933347ff67cf59..28d8fff4cb831fe8dcd24f17955ae9d532f35c03 100644 (file)
--- a/server/helpers/image-utils.ts
+++ b/server/helpers/image-utils.ts
@@ -1,16 +1,21 @@
 import { copy, readFile, remove, rename } from 'fs-extra'
-import * as Jimp from 'jimp'
-import { extname } from 'path'
+import Jimp, { read } from 'jimp'
+import { getLowercaseExtension } from '@shared/core-utils'
+import { buildUUID } from '@shared/extra-utils'
 import { convertWebPToJPG, processGIF } from './ffmpeg-utils'
 import { logger } from './logger'
 
+function generateImageFilename (extension = '.jpg') {
+  return buildUUID() + extension
+}
+
 async function processImage (
   path: string,
   destination: string,
   newSize: { width: number, height: number },
   keepOriginal = false
 ) {
-  const extension = extname(path)
+  const extension = getLowercaseExtension(path)
 
   if (path === destination) {
     throw new Error('Jimp/FFmpeg needs an input path different that the output path.')
@@ -31,17 +36,18 @@ async function processImage (
 // ---------------------------------------------------------------------------
 
 export {
+  generateImageFilename,
   processImage
 }
 
 // ---------------------------------------------------------------------------
 
 async function jimpProcessor (path: string, destination: string, newSize: { width: number, height: number }, inputExt: string) {
-  let jimpInstance: Jimp
+  let sourceImage: Jimp
   const inputBuffer = await readFile(path)
 
   try {
-    jimpInstance = await Jimp.read(inputBuffer)
+    sourceImage = await read(inputBuffer)
   } catch (err) {
     logger.debug('Cannot read %s with jimp. Try to convert the image using ffmpeg first.', path, { err })
 
@@ -49,33 +55,61 @@ async function jimpProcessor (path: string, destination: string, newSize: { widt
     await convertWebPToJPG(path, newName)
     await rename(newName, path)
 
-    jimpInstance = await Jimp.read(path)
+    sourceImage = await read(path)
   }
 
   await remove(destination)
 
   // Optimization if the source file has the appropriate size
-  if (await skipProcessing({ jimpInstance, newSize, imageBytes: inputBuffer.byteLength, inputExt, outputExt: extname(destination) })) {
+  const outputExt = getLowercaseExtension(destination)
+  if (skipProcessing({ sourceImage, newSize, imageBytes: inputBuffer.byteLength, inputExt, outputExt })) {
     return copy(path, destination)
   }
 
-  await jimpInstance
-    .resize(newSize.width, newSize.height)
-    .quality(80)
-    .writeAsync(destination)
+  await autoResize({ sourceImage, newSize, destination })
+}
+
+async function autoResize (options: {
+  sourceImage: Jimp
+  newSize: { width: number, height: number }
+  destination: string
+}) {
+  const { sourceImage, newSize, destination } = options
+
+  // Portrait mode targetting a landscape, apply some effect on the image
+  const sourceIsPortrait = sourceImage.getWidth() < sourceImage.getHeight()
+  const destIsPortraitOrSquare = newSize.width <= newSize.height
+
+  removeExif(sourceImage)
+
+  if (sourceIsPortrait && !destIsPortraitOrSquare) {
+    const baseImage = sourceImage.cloneQuiet().cover(newSize.width, newSize.height)
+                                              .color([ { apply: 'shade', params: [ 50 ] } ])
+
+    const topImage = sourceImage.cloneQuiet().contain(newSize.width, newSize.height)
+
+    return write(baseImage.blit(topImage, 0, 0), destination)
+  }
+
+  return write(sourceImage.cover(newSize.width, newSize.height), destination)
+}
+
+function write (image: Jimp, destination: string) {
+  return image.quality(80).writeAsync(destination)
 }
 
 function skipProcessing (options: {
-  jimpInstance: Jimp
+  sourceImage: Jimp
   newSize: { width: number, height: number }
   imageBytes: number
   inputExt: string
   outputExt: string
 }) {
-  const { jimpInstance, newSize, imageBytes, inputExt, outputExt } = options
+  const { sourceImage, newSize, imageBytes, inputExt, outputExt } = options
   const { width, height } = newSize
 
-  if (jimpInstance.getWidth() > width || jimpInstance.getHeight() > height) return false
+  if (hasExif(sourceImage)) return false
+  if (sourceImage.getWidth() > width || sourceImage.getHeight() > height) return false
   if (inputExt !== outputExt) return false
 
   const kB = 1000
@@ -85,3 +119,11 @@ function skipProcessing (options: {
 
   return imageBytes <= 15 * kB
 }
+
+function hasExif (image: Jimp) {
+  return !!(image.bitmap as any).exifBuffer
+}
+
+function removeExif (image: Jimp) {
+  (image.bitmap as any).exifBuffer = null
+}