]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/helpers/youtube-dl.ts
Merge branch 'release/2.1.0' into develop
[github/Chocobozzz/PeerTube.git] / server / helpers / youtube-dl.ts
index c59ab9de072ef74ef3bbdb09a14055c51cd20ec2..fc9d416a179cd9f9ba92bab7523ac2a062f4bf59 100644 (file)
-import * as youtubeDL from 'youtube-dl'
-import { truncate } from 'lodash'
-import { CONFIG, CONSTRAINTS_FIELDS, VIDEO_CATEGORIES } from '../initializers'
-import { join } from 'path'
-import * as crypto from 'crypto'
+import { CONSTRAINTS_FIELDS, VIDEO_CATEGORIES } from '../initializers/constants'
 import { logger } from './logger'
+import { generateVideoImportTmpPath } from './utils'
+import { join } from 'path'
+import { peertubeTruncate, root } from './core-utils'
+import { ensureDir, remove, writeFile } from 'fs-extra'
+import * as request from 'request'
+import { createWriteStream } from 'fs'
+import { CONFIG } from '@server/initializers/config'
 
 export type YoutubeDLInfo = {
-  name: string
-  description: string
-  category: number
-  licence: number
-  nsfw: boolean
-  tags: string[]
-  thumbnailUrl: string
+  name?: string
+  description?: string
+  category?: number
+  licence?: number
+  nsfw?: boolean
+  tags?: string[]
+  thumbnailUrl?: string
+  originallyPublishedAt?: Date
+}
+
+const processOptions = {
+  maxBuffer: 1024 * 1024 * 10 // 10MB
 }
 
-function getYoutubeDLInfo (url: string): Promise<YoutubeDLInfo> {
+function getYoutubeDLInfo (url: string, opts?: string[]): Promise<YoutubeDLInfo> {
   return new Promise<YoutubeDLInfo>((res, rej) => {
-    const options = [ '-j', '--flat-playlist' ]
+    let args = opts || [ '-j', '--flat-playlist' ]
+    args = wrapWithProxyOptions(args)
+
+    safeGetYoutubeDL()
+      .then(youtubeDL => {
+        youtubeDL.getInfo(url, args, processOptions, (err, info) => {
+          if (err) return rej(err)
+          if (info.is_live === true) return rej(new Error('Cannot download a live streaming.'))
+
+          const obj = buildVideoInfo(normalizeObject(info))
+          if (obj.name && obj.name.length < CONSTRAINTS_FIELDS.VIDEOS.NAME.min) obj.name += ' video'
+
+          return res(obj)
+        })
+      })
+      .catch(err => rej(err))
+  })
+}
+
+function downloadYoutubeDLVideo (url: string, timeout: number) {
+  const path = generateVideoImportTmpPath(url)
+  let timer
 
-    youtubeDL.getInfo(url, options, (err, info) => {
-      if (err) return rej(err)
+  logger.info('Importing youtubeDL video %s', url)
 
-      const obj = normalizeObject(info)
+  let options = [ '-f', 'bestvideo[ext=mp4]+bestaudio[ext=m4a]/best', '-o', path ]
+  options = wrapWithProxyOptions(options)
 
-      return res(buildVideoInfo(obj))
+  if (process.env.FFMPEG_PATH) {
+    options = options.concat([ '--ffmpeg-location', process.env.FFMPEG_PATH ])
+  }
+
+  return new Promise<string>((res, rej) => {
+    safeGetYoutubeDL()
+      .then(youtubeDL => {
+        youtubeDL.exec(url, options, processOptions, err => {
+          clearTimeout(timer)
+
+          if (err) {
+            remove(path)
+              .catch(err => logger.error('Cannot delete path on YoutubeDL error.', { err }))
+
+            return rej(err)
+          }
+
+          return res(path)
+        })
+
+        timer = setTimeout(() => {
+          const err = new Error('YoutubeDL download timeout.')
+
+          remove(path)
+            .finally(() => rej(err))
+            .catch(err => {
+              logger.error('Cannot remove %s in youtubeDL timeout.', path, { err })
+              return rej(err)
+            })
+        }, timeout)
+      })
+      .catch(err => rej(err))
+  })
+}
+
+// Thanks: https://github.com/przemyslawpluta/node-youtube-dl/blob/master/lib/downloader.js
+// We rewrote it to avoid sync calls
+async function updateYoutubeDLBinary () {
+  logger.info('Updating youtubeDL binary.')
+
+  const binDirectory = join(root(), 'node_modules', 'youtube-dl', 'bin')
+  const bin = join(binDirectory, 'youtube-dl')
+  const detailsPath = join(binDirectory, 'details')
+  const url = 'https://yt-dl.org/downloads/latest/youtube-dl'
+
+  await ensureDir(binDirectory)
+
+  return new Promise(res => {
+    request.get(url, { followRedirect: false }, (err, result) => {
+      if (err) {
+        logger.error('Cannot update youtube-dl.', { err })
+        return res()
+      }
+
+      if (result.statusCode !== 302) {
+        logger.error('youtube-dl update error: did not get redirect for the latest version link. Status %d', result.statusCode)
+        return res()
+      }
+
+      const url = result.headers.location
+      const downloadFile = request.get(url)
+      const newVersion = /yt-dl\.org\/downloads\/(\d{4}\.\d\d\.\d\d(\.\d)?)\/youtube-dl/.exec(url)[1]
+
+      downloadFile.on('response', result => {
+        if (result.statusCode !== 200) {
+          logger.error('Cannot update youtube-dl: new version response is not 200, it\'s %d.', result.statusCode)
+          return res()
+        }
+
+        downloadFile.pipe(createWriteStream(bin, { mode: 493 }))
+      })
+
+      downloadFile.on('error', err => {
+        logger.error('youtube-dl update error.', { err })
+        return res()
+      })
+
+      downloadFile.on('end', () => {
+        const details = JSON.stringify({ version: newVersion, path: bin, exec: 'youtube-dl' })
+        writeFile(detailsPath, details, { encoding: 'utf8' }, err => {
+          if (err) {
+            logger.error('youtube-dl update error: cannot write details.', { err })
+            return res()
+          }
+
+          logger.info('youtube-dl updated to version %s.', newVersion)
+          return res()
+        })
+      })
     })
   })
 }
 
-function downloadYoutubeDLVideo (url: string) {
-  const hash = crypto.createHash('sha256').update(url).digest('hex')
-  const path = join(CONFIG.STORAGE.VIDEOS_DIR, hash + '-import.mp4')
+async function safeGetYoutubeDL () {
+  let youtubeDL
 
-  logger.info('Importing video %s', url)
+  try {
+    youtubeDL = require('youtube-dl')
+  } catch (e) {
+    // Download binary
+    await updateYoutubeDLBinary()
+    youtubeDL = require('youtube-dl')
+  }
 
-  const options = [ '-f', 'bestvideo[ext=mp4]+bestaudio[ext=m4a]/best', '-o', path ]
+  return youtubeDL
+}
 
-  return new Promise<string>((res, rej) => {
-    youtubeDL.exec(url, options, async (err, output) => {
-      if (err) return rej(err)
+function buildOriginallyPublishedAt (obj: any) {
+  let originallyPublishedAt: Date = null
 
-      return res(path)
-    })
-  })
+  const uploadDateMatcher = /^(\d{4})(\d{2})(\d{2})$/.exec(obj.upload_date)
+  if (uploadDateMatcher) {
+    originallyPublishedAt = new Date()
+    originallyPublishedAt.setHours(0, 0, 0, 0)
+
+    const year = parseInt(uploadDateMatcher[1], 10)
+    // Month starts from 0
+    const month = parseInt(uploadDateMatcher[2], 10) - 1
+    const day = parseInt(uploadDateMatcher[3], 10)
+
+    originallyPublishedAt.setFullYear(year, month, day)
+  }
+
+  return originallyPublishedAt
 }
 
 // ---------------------------------------------------------------------------
 
 export {
+  updateYoutubeDLBinary,
   downloadYoutubeDLVideo,
-  getYoutubeDLInfo
+  getYoutubeDLInfo,
+  safeGetYoutubeDL,
+  buildOriginallyPublishedAt
 }
 
 // ---------------------------------------------------------------------------
@@ -82,25 +218,26 @@ function buildVideoInfo (obj: any) {
     licence: getLicence(obj.license),
     nsfw: isNSFW(obj),
     tags: getTags(obj.tags),
-    thumbnailUrl: obj.thumbnail || undefined
+    thumbnailUrl: obj.thumbnail || undefined,
+    originallyPublishedAt: buildOriginallyPublishedAt(obj)
   }
 }
 
 function titleTruncation (title: string) {
-  return truncate(title, {
-    'length': CONSTRAINTS_FIELDS.VIDEOS.NAME.max,
-    'separator': /,? +/,
-    'omission': ' […]'
+  return peertubeTruncate(title, {
+    length: CONSTRAINTS_FIELDS.VIDEOS.NAME.max,
+    separator: /,? +/,
+    omission: ' […]'
   })
 }
 
 function descriptionTruncation (description: string) {
   if (!description || description.length < CONSTRAINTS_FIELDS.VIDEOS.DESCRIPTION.min) return undefined
 
-  return truncate(description, {
-    'length': CONSTRAINTS_FIELDS.VIDEOS.DESCRIPTION.max,
-    'separator': /,? +/,
-    'omission': ' […]'
+  return peertubeTruncate(description, {
+    length: CONSTRAINTS_FIELDS.VIDEOS.DESCRIPTION.max,
+    separator: /,? +/,
+    omission: ' […]'
   })
 }
 
@@ -140,3 +277,13 @@ function getCategory (categories: string[]) {
 
   return undefined
 }
+
+function wrapWithProxyOptions (options: string[]) {
+  if (CONFIG.IMPORT.VIDEOS.HTTP.PROXY.ENABLED) {
+    logger.debug('Using proxy for YoutubeDL')
+
+    return [ '--proxy', CONFIG.IMPORT.VIDEOS.HTTP.PROXY.URL ].concat(options)
+  }
+
+  return options
+}