1 import { createWriteStream } from 'fs'
2 import { ensureDir, move, pathExists, remove, writeFile } from 'fs-extra'
4 import { join } from 'path'
5 import { CONFIG } from '@server/initializers/config'
6 import { HttpStatusCode } from '../../shared/core-utils/miscs/http-error-codes'
7 import { VideoResolution } from '../../shared/models/videos'
8 import { CONSTRAINTS_FIELDS, VIDEO_CATEGORIES, VIDEO_LANGUAGES, VIDEO_LICENCES } from '../initializers/constants'
9 import { getEnabledResolutions } from '../lib/video-transcoding'
10 import { peertubeTruncate, pipelinePromise, root } from './core-utils'
11 import { isVideoFileExtnameValid } from './custom-validators/videos'
12 import { logger } from './logger'
13 import { generateVideoImportTmpPath } from './utils'
15 export type YoutubeDLInfo = {
25 originallyPublishedAt?: Date
28 export type YoutubeDLSubs = {
34 const processOptions = {
35 maxBuffer: 1024 * 1024 * 10 // 10MB
38 function getYoutubeDLInfo (url: string, opts?: string[]): Promise<YoutubeDLInfo> {
39 return new Promise<YoutubeDLInfo>((res, rej) => {
40 let args = opts || [ '-j', '--flat-playlist' ]
42 if (CONFIG.IMPORT.VIDEOS.HTTP.FORCE_IPV4) {
43 args.push('--force-ipv4')
46 args = wrapWithProxyOptions(args)
47 args = [ '-f', getYoutubeDLVideoFormat() ].concat(args)
51 youtubeDL.getInfo(url, args, processOptions, (err, info) => {
52 if (err) return rej(err)
53 if (info.is_live === true) return rej(new Error('Cannot download a live streaming.'))
55 const obj = buildVideoInfo(normalizeObject(info))
56 if (obj.name && obj.name.length < CONSTRAINTS_FIELDS.VIDEOS.NAME.min) obj.name += ' video'
61 .catch(err => rej(err))
65 function getYoutubeDLSubs (url: string, opts?: object): Promise<YoutubeDLSubs> {
66 return new Promise<YoutubeDLSubs>((res, rej) => {
67 const cwd = CONFIG.STORAGE.TMP_DIR
68 const options = opts || { all: true, format: 'vtt', cwd }
72 youtubeDL.getSubs(url, options, (err, files) => {
73 if (err) return rej(err)
76 logger.debug('Get subtitles from youtube dl.', { url, files })
78 const subtitles = files.reduce((acc, filename) => {
79 const matched = filename.match(/\.([a-z]{2})(-[a-z]+)?\.(vtt|ttml)/i)
80 if (!matched || !matched[1]) return acc
86 path: join(cwd, filename),
95 .catch(err => rej(err))
99 function getYoutubeDLVideoFormat () {
101 * list of format selectors in order or preference
102 * see https://github.com/ytdl-org/youtube-dl#format-selection
104 * case #1 asks for a mp4 using h264 (avc1) and the exact resolution in the hope
105 * of being able to do a "quick-transcode"
106 * case #2 is the first fallback. No "quick-transcode" means we can get anything else (like vp9)
107 * case #3 is the resolution-degraded equivalent of #1, and already a pretty safe fallback
109 * in any case we avoid AV1, see https://github.com/Chocobozzz/PeerTube/issues/3499
111 const enabledResolutions = getEnabledResolutions('vod')
112 const resolution = enabledResolutions.length === 0
113 ? VideoResolution.H_720P
114 : Math.max(...enabledResolutions)
117 `bestvideo[vcodec^=avc1][height=${resolution}]+bestaudio[ext=m4a]`, // case #1
118 `bestvideo[vcodec!*=av01][vcodec!*=vp9.2][height=${resolution}]+bestaudio`, // case #2
119 `bestvideo[vcodec^=avc1][height<=${resolution}]+bestaudio[ext=m4a]`, // case #3
120 `bestvideo[vcodec!*=av01][vcodec!*=vp9.2]+bestaudio`,
121 'best[vcodec!*=av01][vcodec!*=vp9.2]', // case fallback for known formats
122 'best' // Ultimate fallback
126 function downloadYoutubeDLVideo (url: string, fileExt: string, timeout: number) {
127 // Leave empty the extension, youtube-dl will add it
128 const pathWithoutExtension = generateVideoImportTmpPath(url, '')
132 logger.info('Importing youtubeDL video %s to %s', url, pathWithoutExtension)
134 let options = [ '-f', getYoutubeDLVideoFormat(), '-o', pathWithoutExtension ]
135 options = wrapWithProxyOptions(options)
137 if (process.env.FFMPEG_PATH) {
138 options = options.concat([ '--ffmpeg-location', process.env.FFMPEG_PATH ])
141 logger.debug('YoutubeDL options for %s.', url, { options })
143 return new Promise<string>((res, rej) => {
146 youtubeDL.exec(url, options, processOptions, async err => {
150 // If youtube-dl did not guess an extension for our file, just use .mp4 as default
151 if (await pathExists(pathWithoutExtension)) {
152 await move(pathWithoutExtension, pathWithoutExtension + '.mp4')
155 const path = await guessVideoPathWithExtension(pathWithoutExtension, fileExt)
159 .catch(err => logger.error('Cannot delete path on YoutubeDL error.', { err }))
170 timer = setTimeout(() => {
171 const err = new Error('YoutubeDL download timeout.')
173 guessVideoPathWithExtension(pathWithoutExtension, fileExt)
174 .then(path => remove(path))
175 .finally(() => rej(err))
177 logger.error('Cannot remove file in youtubeDL timeout.', { err })
182 .catch(err => rej(err))
186 // Thanks: https://github.com/przemyslawpluta/node-youtube-dl/blob/master/lib/downloader.js
187 // We rewrote it to avoid sync calls
188 async function updateYoutubeDLBinary () {
189 logger.info('Updating youtubeDL binary.')
191 const binDirectory = join(root(), 'node_modules', 'youtube-dl', 'bin')
192 const bin = join(binDirectory, 'youtube-dl')
193 const detailsPath = join(binDirectory, 'details')
194 const url = process.env.YOUTUBE_DL_DOWNLOAD_HOST || 'https://yt-dl.org/downloads/latest/youtube-dl'
196 await ensureDir(binDirectory)
199 const result = await got(url, { followRedirect: false })
201 if (result.statusCode !== HttpStatusCode.FOUND_302) {
202 logger.error('youtube-dl update error: did not get redirect for the latest version link. Status %d', result.statusCode)
206 const newUrl = result.headers.location
207 const newVersion = /yt-dl\.org\/downloads\/(\d{4}\.\d\d\.\d\d(\.\d)?)\/youtube-dl/.exec(newUrl)[1]
209 const downloadFileStream = got.stream(newUrl)
210 const writeStream = createWriteStream(bin, { mode: 493 })
212 await pipelinePromise(
217 const details = JSON.stringify({ version: newVersion, path: bin, exec: 'youtube-dl' })
218 await writeFile(detailsPath, details, { encoding: 'utf8' })
220 logger.info('youtube-dl updated to version %s.', newVersion)
222 logger.error('Cannot update youtube-dl.', { err })
226 async function safeGetYoutubeDL () {
230 youtubeDL = require('youtube-dl')
233 await updateYoutubeDLBinary()
234 youtubeDL = require('youtube-dl')
240 function buildOriginallyPublishedAt (obj: any) {
241 let originallyPublishedAt: Date = null
243 const uploadDateMatcher = /^(\d{4})(\d{2})(\d{2})$/.exec(obj.upload_date)
244 if (uploadDateMatcher) {
245 originallyPublishedAt = new Date()
246 originallyPublishedAt.setHours(0, 0, 0, 0)
248 const year = parseInt(uploadDateMatcher[1], 10)
249 // Month starts from 0
250 const month = parseInt(uploadDateMatcher[2], 10) - 1
251 const day = parseInt(uploadDateMatcher[3], 10)
253 originallyPublishedAt.setFullYear(year, month, day)
256 return originallyPublishedAt
259 // ---------------------------------------------------------------------------
262 updateYoutubeDLBinary,
263 getYoutubeDLVideoFormat,
264 downloadYoutubeDLVideo,
268 buildOriginallyPublishedAt
271 // ---------------------------------------------------------------------------
273 async function guessVideoPathWithExtension (tmpPath: string, sourceExt: string) {
274 if (!isVideoFileExtnameValid(sourceExt)) {
275 throw new Error('Invalid video extension ' + sourceExt)
278 const extensions = [ sourceExt, '.mp4', '.mkv', '.webm' ]
280 for (const extension of extensions) {
281 const path = tmpPath + extension
283 if (await pathExists(path)) return path
286 throw new Error('Cannot guess path of ' + tmpPath)
289 function normalizeObject (obj: any) {
290 const newObj: any = {}
292 for (const key of Object.keys(obj)) {
294 if (key === 'resolution') continue
296 const value = obj[key]
298 if (typeof value === 'string') {
299 newObj[key] = value.normalize()
308 function buildVideoInfo (obj: any): YoutubeDLInfo {
310 name: titleTruncation(obj.title),
311 description: descriptionTruncation(obj.description),
312 category: getCategory(obj.categories),
313 licence: getLicence(obj.license),
314 language: getLanguage(obj.language),
316 tags: getTags(obj.tags),
317 thumbnailUrl: obj.thumbnail || undefined,
318 originallyPublishedAt: buildOriginallyPublishedAt(obj),
323 function titleTruncation (title: string) {
324 return peertubeTruncate(title, {
325 length: CONSTRAINTS_FIELDS.VIDEOS.NAME.max,
331 function descriptionTruncation (description: string) {
332 if (!description || description.length < CONSTRAINTS_FIELDS.VIDEOS.DESCRIPTION.min) return undefined
334 return peertubeTruncate(description, {
335 length: CONSTRAINTS_FIELDS.VIDEOS.DESCRIPTION.max,
341 function isNSFW (info: any) {
342 return info.age_limit && info.age_limit >= 16
345 function getTags (tags: any) {
346 if (Array.isArray(tags) === false) return []
349 .filter(t => t.length < CONSTRAINTS_FIELDS.VIDEOS.TAG.max && t.length > CONSTRAINTS_FIELDS.VIDEOS.TAG.min)
350 .map(t => t.normalize())
354 function getLicence (licence: string) {
355 if (!licence) return undefined
357 if (licence.includes('Creative Commons Attribution')) return 1
359 for (const key of Object.keys(VIDEO_LICENCES)) {
360 const peertubeLicence = VIDEO_LICENCES[key]
361 if (peertubeLicence.toLowerCase() === licence.toLowerCase()) return parseInt(key, 10)
367 function getCategory (categories: string[]) {
368 if (!categories) return undefined
370 const categoryString = categories[0]
371 if (!categoryString || typeof categoryString !== 'string') return undefined
373 if (categoryString === 'News & Politics') return 11
375 for (const key of Object.keys(VIDEO_CATEGORIES)) {
376 const category = VIDEO_CATEGORIES[key]
377 if (categoryString.toLowerCase() === category.toLowerCase()) return parseInt(key, 10)
383 function getLanguage (language: string) {
384 return VIDEO_LANGUAGES[language] ? language : undefined
387 function wrapWithProxyOptions (options: string[]) {
388 if (CONFIG.IMPORT.VIDEOS.HTTP.PROXY.ENABLED) {
389 logger.debug('Using proxy for YoutubeDL')
391 return [ '--proxy', CONFIG.IMPORT.VIDEOS.HTTP.PROXY.URL ].concat(options)