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 { peertubeTruncate, pipelinePromise, root } from './core-utils'
10 import { isVideoFileExtnameValid } from './custom-validators/videos'
11 import { logger } from './logger'
12 import { generateVideoImportTmpPath } from './utils'
14 export type YoutubeDLInfo = {
24 originallyPublishedAt?: Date
27 export type YoutubeDLSubs = {
33 const processOptions = {
34 maxBuffer: 1024 * 1024 * 10 // 10MB
39 constructor (private readonly url: string = '', private readonly enabledResolutions: number[] = []) {
43 getYoutubeDLInfo (opts?: string[]): Promise<YoutubeDLInfo> {
44 return new Promise<YoutubeDLInfo>((res, rej) => {
45 let args = opts || [ '-j', '--flat-playlist' ]
47 if (CONFIG.IMPORT.VIDEOS.HTTP.FORCE_IPV4) {
48 args.push('--force-ipv4')
51 args = this.wrapWithProxyOptions(args)
52 args = [ '-f', this.getYoutubeDLVideoFormat() ].concat(args)
54 YoutubeDL.safeGetYoutubeDL()
56 youtubeDL.getInfo(this.url, args, processOptions, (err, info) => {
57 if (err) return rej(err)
58 if (info.is_live === true) return rej(new Error('Cannot download a live streaming.'))
60 const obj = this.buildVideoInfo(this.normalizeObject(info))
61 if (obj.name && obj.name.length < CONSTRAINTS_FIELDS.VIDEOS.NAME.min) obj.name += ' video'
66 .catch(err => rej(err))
70 getYoutubeDLSubs (opts?: object): Promise<YoutubeDLSubs> {
71 return new Promise<YoutubeDLSubs>((res, rej) => {
72 const cwd = CONFIG.STORAGE.TMP_DIR
73 const options = opts || { all: true, format: 'vtt', cwd }
75 YoutubeDL.safeGetYoutubeDL()
77 youtubeDL.getSubs(this.url, options, (err, files) => {
78 if (err) return rej(err)
81 logger.debug('Get subtitles from youtube dl.', { url: this.url, files })
83 const subtitles = files.reduce((acc, filename) => {
84 const matched = filename.match(/\.([a-z]{2})(-[a-z]+)?\.(vtt|ttml)/i)
85 if (!matched || !matched[1]) return acc
91 path: join(cwd, filename),
100 .catch(err => rej(err))
104 getYoutubeDLVideoFormat () {
106 * list of format selectors in order or preference
107 * see https://github.com/ytdl-org/youtube-dl#format-selection
109 * case #1 asks for a mp4 using h264 (avc1) and the exact resolution in the hope
110 * of being able to do a "quick-transcode"
111 * case #2 is the first fallback. No "quick-transcode" means we can get anything else (like vp9)
112 * case #3 is the resolution-degraded equivalent of #1, and already a pretty safe fallback
114 * in any case we avoid AV1, see https://github.com/Chocobozzz/PeerTube/issues/3499
116 const resolution = this.enabledResolutions.length === 0
117 ? VideoResolution.H_720P
118 : Math.max(...this.enabledResolutions)
121 `bestvideo[vcodec^=avc1][height=${resolution}]+bestaudio[ext=m4a]`, // case #1
122 `bestvideo[vcodec!*=av01][vcodec!*=vp9.2][height=${resolution}]+bestaudio`, // case #2
123 `bestvideo[vcodec^=avc1][height<=${resolution}]+bestaudio[ext=m4a]`, // case #3
124 `bestvideo[vcodec!*=av01][vcodec!*=vp9.2]+bestaudio`,
125 'best[vcodec!*=av01][vcodec!*=vp9.2]', // case fallback for known formats
126 'best' // Ultimate fallback
130 downloadYoutubeDLVideo (fileExt: string, timeout: number) {
131 // Leave empty the extension, youtube-dl will add it
132 const pathWithoutExtension = generateVideoImportTmpPath(this.url, '')
136 logger.info('Importing youtubeDL video %s to %s', this.url, pathWithoutExtension)
138 let options = [ '-f', this.getYoutubeDLVideoFormat(), '-o', pathWithoutExtension ]
139 options = this.wrapWithProxyOptions(options)
141 if (process.env.FFMPEG_PATH) {
142 options = options.concat([ '--ffmpeg-location', process.env.FFMPEG_PATH ])
145 logger.debug('YoutubeDL options for %s.', this.url, { options })
147 return new Promise<string>((res, rej) => {
148 YoutubeDL.safeGetYoutubeDL()
150 youtubeDL.exec(this.url, options, processOptions, async err => {
154 // If youtube-dl did not guess an extension for our file, just use .mp4 as default
155 if (await pathExists(pathWithoutExtension)) {
156 await move(pathWithoutExtension, pathWithoutExtension + '.mp4')
159 const path = await this.guessVideoPathWithExtension(pathWithoutExtension, fileExt)
163 .catch(err => logger.error('Cannot delete path on YoutubeDL error.', { err }))
174 timer = setTimeout(() => {
175 const err = new Error('YoutubeDL download timeout.')
177 this.guessVideoPathWithExtension(pathWithoutExtension, fileExt)
178 .then(path => remove(path))
179 .finally(() => rej(err))
181 logger.error('Cannot remove file in youtubeDL timeout.', { err })
186 .catch(err => rej(err))
190 buildOriginallyPublishedAt (obj: any) {
191 let originallyPublishedAt: Date = null
193 const uploadDateMatcher = /^(\d{4})(\d{2})(\d{2})$/.exec(obj.upload_date)
194 if (uploadDateMatcher) {
195 originallyPublishedAt = new Date()
196 originallyPublishedAt.setHours(0, 0, 0, 0)
198 const year = parseInt(uploadDateMatcher[1], 10)
199 // Month starts from 0
200 const month = parseInt(uploadDateMatcher[2], 10) - 1
201 const day = parseInt(uploadDateMatcher[3], 10)
203 originallyPublishedAt.setFullYear(year, month, day)
206 return originallyPublishedAt
209 private async guessVideoPathWithExtension (tmpPath: string, sourceExt: string) {
210 if (!isVideoFileExtnameValid(sourceExt)) {
211 throw new Error('Invalid video extension ' + sourceExt)
214 const extensions = [ sourceExt, '.mp4', '.mkv', '.webm' ]
216 for (const extension of extensions) {
217 const path = tmpPath + extension
219 if (await pathExists(path)) return path
222 throw new Error('Cannot guess path of ' + tmpPath)
225 private normalizeObject (obj: any) {
226 const newObj: any = {}
228 for (const key of Object.keys(obj)) {
230 if (key === 'resolution') continue
232 const value = obj[key]
234 if (typeof value === 'string') {
235 newObj[key] = value.normalize()
244 private buildVideoInfo (obj: any): YoutubeDLInfo {
246 name: this.titleTruncation(obj.title),
247 description: this.descriptionTruncation(obj.description),
248 category: this.getCategory(obj.categories),
249 licence: this.getLicence(obj.license),
250 language: this.getLanguage(obj.language),
251 nsfw: this.isNSFW(obj),
252 tags: this.getTags(obj.tags),
253 thumbnailUrl: obj.thumbnail || undefined,
254 originallyPublishedAt: this.buildOriginallyPublishedAt(obj),
259 private titleTruncation (title: string) {
260 return peertubeTruncate(title, {
261 length: CONSTRAINTS_FIELDS.VIDEOS.NAME.max,
267 private descriptionTruncation (description: string) {
268 if (!description || description.length < CONSTRAINTS_FIELDS.VIDEOS.DESCRIPTION.min) return undefined
270 return peertubeTruncate(description, {
271 length: CONSTRAINTS_FIELDS.VIDEOS.DESCRIPTION.max,
277 private isNSFW (info: any) {
278 return info.age_limit && info.age_limit >= 16
281 private getTags (tags: any) {
282 if (Array.isArray(tags) === false) return []
285 .filter(t => t.length < CONSTRAINTS_FIELDS.VIDEOS.TAG.max && t.length > CONSTRAINTS_FIELDS.VIDEOS.TAG.min)
286 .map(t => t.normalize())
290 private getLicence (licence: string) {
291 if (!licence) return undefined
293 if (licence.includes('Creative Commons Attribution')) return 1
295 for (const key of Object.keys(VIDEO_LICENCES)) {
296 const peertubeLicence = VIDEO_LICENCES[key]
297 if (peertubeLicence.toLowerCase() === licence.toLowerCase()) return parseInt(key, 10)
303 private getCategory (categories: string[]) {
304 if (!categories) return undefined
306 const categoryString = categories[0]
307 if (!categoryString || typeof categoryString !== 'string') return undefined
309 if (categoryString === 'News & Politics') return 11
311 for (const key of Object.keys(VIDEO_CATEGORIES)) {
312 const category = VIDEO_CATEGORIES[key]
313 if (categoryString.toLowerCase() === category.toLowerCase()) return parseInt(key, 10)
319 private getLanguage (language: string) {
320 return VIDEO_LANGUAGES[language] ? language : undefined
323 private wrapWithProxyOptions (options: string[]) {
324 if (CONFIG.IMPORT.VIDEOS.HTTP.PROXY.ENABLED) {
325 logger.debug('Using proxy for YoutubeDL')
327 return [ '--proxy', CONFIG.IMPORT.VIDEOS.HTTP.PROXY.URL ].concat(options)
333 // Thanks: https://github.com/przemyslawpluta/node-youtube-dl/blob/master/lib/downloader.js
334 // We rewrote it to avoid sync calls
335 static async updateYoutubeDLBinary () {
336 logger.info('Updating youtubeDL binary.')
338 const binDirectory = join(root(), 'node_modules', 'youtube-dl', 'bin')
339 const bin = join(binDirectory, 'youtube-dl')
340 const detailsPath = join(binDirectory, 'details')
341 const url = process.env.YOUTUBE_DL_DOWNLOAD_HOST || 'https://yt-dl.org/downloads/latest/youtube-dl'
343 await ensureDir(binDirectory)
346 const result = await got(url, { followRedirect: false })
348 if (result.statusCode !== HttpStatusCode.FOUND_302) {
349 logger.error('youtube-dl update error: did not get redirect for the latest version link. Status %d', result.statusCode)
353 const newUrl = result.headers.location
354 const newVersion = /yt-dl\.org\/downloads\/(\d{4}\.\d\d\.\d\d(\.\d)?)\/youtube-dl/.exec(newUrl)[1]
356 const downloadFileStream = got.stream(newUrl)
357 const writeStream = createWriteStream(bin, { mode: 493 })
359 await pipelinePromise(
364 const details = JSON.stringify({ version: newVersion, path: bin, exec: 'youtube-dl' })
365 await writeFile(detailsPath, details, { encoding: 'utf8' })
367 logger.info('youtube-dl updated to version %s.', newVersion)
369 logger.error('Cannot update youtube-dl.', { err })
373 static async safeGetYoutubeDL () {
377 youtubeDL = require('youtube-dl')
380 await this.updateYoutubeDLBinary()
381 youtubeDL = require('youtube-dl')
388 // ---------------------------------------------------------------------------