X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fhelpers%2Fyoutube-dl.ts;h=3c80e7d41ccc10954ee6566e985a916a883ace30;hb=0bae66632a8767f3d5aca080af314bcab56e1889;hp=8537a57722c57f9079ceb746dbc28f8ead0e7e4f;hpb=ba5a8d89bbf049e4afc41543bcc072cccdb02669;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/helpers/youtube-dl.ts b/server/helpers/youtube-dl.ts index 8537a5772..3c80e7d41 100644 --- a/server/helpers/youtube-dl.ts +++ b/server/helpers/youtube-dl.ts @@ -1,13 +1,12 @@ import { createWriteStream } from 'fs' import { ensureDir, move, pathExists, remove, writeFile } from 'fs-extra' +import got from 'got' import { join } from 'path' -import * as request from 'request' import { CONFIG } from '@server/initializers/config' -import { HttpStatusCode } from '../../shared/core-utils/miscs/http-error-codes' +import { HttpStatusCode } from '../../shared/models/http/http-error-codes' import { VideoResolution } from '../../shared/models/videos' import { CONSTRAINTS_FIELDS, VIDEO_CATEGORIES, VIDEO_LANGUAGES, VIDEO_LICENCES } from '../initializers/constants' -import { getEnabledResolutions } from '../lib/video-transcoding' -import { peertubeTruncate, root } from './core-utils' +import { peertubeTruncate, pipelinePromise, root } from './core-utils' import { isVideoFileExtnameValid } from './custom-validators/videos' import { logger } from './logger' import { generateVideoImportTmpPath } from './utils' @@ -35,384 +34,359 @@ const processOptions = { maxBuffer: 1024 * 1024 * 10 // 10MB } -function getYoutubeDLInfo (url: string, opts?: string[]): Promise { - return new Promise((res, rej) => { - let args = opts || [ '-j', '--flat-playlist' ] +class YoutubeDL { - if (CONFIG.IMPORT.VIDEOS.HTTP.FORCE_IPV4) { - args.push('--force-ipv4') - } + constructor (private readonly url: string = '', private readonly enabledResolutions: number[] = []) { - args = wrapWithProxyOptions(args) - args = [ '-f', getYoutubeDLVideoFormat() ].concat(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.')) + getYoutubeDLInfo (opts?: string[]): Promise { + return new Promise((res, rej) => { + let args = opts || [] - const obj = buildVideoInfo(normalizeObject(info)) - if (obj.name && obj.name.length < CONSTRAINTS_FIELDS.VIDEOS.NAME.min) obj.name += ' video' + if (CONFIG.IMPORT.VIDEOS.HTTP.FORCE_IPV4) { + args.push('--force-ipv4') + } - return res(obj) - }) - }) - .catch(err => rej(err)) - }) -} + args = this.wrapWithProxyOptions(args) + args = [ '-f', this.getYoutubeDLVideoFormat() ].concat(args) -function getYoutubeDLSubs (url: string, opts?: object): Promise { - return new Promise((res, rej) => { - const cwd = CONFIG.STORAGE.TMP_DIR - const options = opts || { all: true, format: 'vtt', cwd } - - safeGetYoutubeDL() - .then(youtubeDL => { - youtubeDL.getSubs(url, options, (err, files) => { - if (err) return rej(err) - if (!files) return [] - - logger.debug('Get subtitles from youtube dl.', { url, files }) - - const subtitles = files.reduce((acc, filename) => { - const matched = filename.match(/\.([a-z]{2})\.(vtt|ttml)/i) - if (!matched || !matched[1]) return acc - - return [ - ...acc, - { - language: matched[1], - path: join(cwd, filename), - filename - } - ] - }, []) + YoutubeDL.safeGetYoutubeDL() + .then(youtubeDL => { + youtubeDL.getInfo(this.url, args, processOptions, (err, info) => { + if (err) return rej(err) + if (info.is_live === true) return rej(new Error('Cannot download a live streaming.')) - return res(subtitles) + const obj = this.buildVideoInfo(this.normalizeObject(info)) + if (obj.name && obj.name.length < CONSTRAINTS_FIELDS.VIDEOS.NAME.min) obj.name += ' video' + + return res(obj) + }) }) - }) - .catch(err => rej(err)) - }) -} + .catch(err => rej(err)) + }) + } -function getYoutubeDLVideoFormat () { - /** - * list of format selectors in order or preference - * see https://github.com/ytdl-org/youtube-dl#format-selection - * - * case #1 asks for a mp4 using h264 (avc1) and the exact resolution in the hope - * of being able to do a "quick-transcode" - * case #2 is the first fallback. No "quick-transcode" means we can get anything else (like vp9) - * case #3 is the resolution-degraded equivalent of #1, and already a pretty safe fallback - * - * in any case we avoid AV1, see https://github.com/Chocobozzz/PeerTube/issues/3499 - **/ - const enabledResolutions = getEnabledResolutions('vod') - const resolution = enabledResolutions.length === 0 - ? VideoResolution.H_720P - : Math.max(...enabledResolutions) - - return [ - `bestvideo[vcodec^=avc1][height=${resolution}]+bestaudio[ext=m4a]`, // case #1 - `bestvideo[vcodec!*=av01][vcodec!*=vp9.2][height=${resolution}]+bestaudio`, // case #2 - `bestvideo[vcodec^=avc1][height<=${resolution}]+bestaudio[ext=m4a]`, // case #3 - `bestvideo[vcodec!*=av01][vcodec!*=vp9.2]+bestaudio`, - 'best[vcodec!*=av01][vcodec!*=vp9.2]', // case fallback for known formats - 'best' // Ultimate fallback - ].join('/') -} + getYoutubeDLSubs (opts?: object): Promise { + return new Promise((res, rej) => { + const cwd = CONFIG.STORAGE.TMP_DIR + const options = opts || { all: true, format: 'vtt', cwd } + + YoutubeDL.safeGetYoutubeDL() + .then(youtubeDL => { + youtubeDL.getSubs(this.url, options, (err, files) => { + if (err) return rej(err) + if (!files) return [] + + logger.debug('Get subtitles from youtube dl.', { url: this.url, files }) + + const subtitles = files.reduce((acc, filename) => { + const matched = filename.match(/\.([a-z]{2})(-[a-z]+)?\.(vtt|ttml)/i) + if (!matched || !matched[1]) return acc + + return [ + ...acc, + { + language: matched[1], + path: join(cwd, filename), + filename + } + ] + }, []) + + return res(subtitles) + }) + }) + .catch(err => rej(err)) + }) + } -function downloadYoutubeDLVideo (url: string, fileExt: string, timeout: number) { - // Leave empty the extension, youtube-dl will add it - const pathWithoutExtension = generateVideoImportTmpPath(url, '') + getYoutubeDLVideoFormat () { + /** + * list of format selectors in order or preference + * see https://github.com/ytdl-org/youtube-dl#format-selection + * + * case #1 asks for a mp4 using h264 (avc1) and the exact resolution in the hope + * of being able to do a "quick-transcode" + * case #2 is the first fallback. No "quick-transcode" means we can get anything else (like vp9) + * case #3 is the resolution-degraded equivalent of #1, and already a pretty safe fallback + * + * in any case we avoid AV1, see https://github.com/Chocobozzz/PeerTube/issues/3499 + **/ + const resolution = this.enabledResolutions.length === 0 + ? VideoResolution.H_720P + : Math.max(...this.enabledResolutions) + + return [ + `bestvideo[vcodec^=avc1][height=${resolution}]+bestaudio[ext=m4a]`, // case #1 + `bestvideo[vcodec!*=av01][vcodec!*=vp9.2][height=${resolution}]+bestaudio`, // case #2 + `bestvideo[vcodec^=avc1][height<=${resolution}]+bestaudio[ext=m4a]`, // case #3 + `bestvideo[vcodec!*=av01][vcodec!*=vp9.2]+bestaudio`, + 'best[vcodec!*=av01][vcodec!*=vp9.2]', // case fallback for known formats + 'best' // Ultimate fallback + ].join('/') + } - let timer + downloadYoutubeDLVideo (fileExt: string, timeout: number) { + // Leave empty the extension, youtube-dl will add it + const pathWithoutExtension = generateVideoImportTmpPath(this.url, '') - logger.info('Importing youtubeDL video %s to %s', url, pathWithoutExtension) + let timer - let options = [ '-f', getYoutubeDLVideoFormat(), '-o', pathWithoutExtension ] - options = wrapWithProxyOptions(options) + logger.info('Importing youtubeDL video %s to %s', this.url, pathWithoutExtension) - if (process.env.FFMPEG_PATH) { - options = options.concat([ '--ffmpeg-location', process.env.FFMPEG_PATH ]) - } + let options = [ '-f', this.getYoutubeDLVideoFormat(), '-o', pathWithoutExtension ] + options = this.wrapWithProxyOptions(options) - logger.debug('YoutubeDL options for %s.', url, { options }) + if (process.env.FFMPEG_PATH) { + options = options.concat([ '--ffmpeg-location', process.env.FFMPEG_PATH ]) + } - return new Promise((res, rej) => { - safeGetYoutubeDL() - .then(youtubeDL => { - youtubeDL.exec(url, options, processOptions, async err => { - clearTimeout(timer) + logger.debug('YoutubeDL options for %s.', this.url, { options }) - try { - // If youtube-dl did not guess an extension for our file, just use .mp4 as default - if (await pathExists(pathWithoutExtension)) { - await move(pathWithoutExtension, pathWithoutExtension + '.mp4') - } + return new Promise((res, rej) => { + YoutubeDL.safeGetYoutubeDL() + .then(youtubeDL => { + youtubeDL.exec(this.url, options, processOptions, async err => { + clearTimeout(timer) + + try { + // If youtube-dl did not guess an extension for our file, just use .mp4 as default + if (await pathExists(pathWithoutExtension)) { + await move(pathWithoutExtension, pathWithoutExtension + '.mp4') + } - const path = await guessVideoPathWithExtension(pathWithoutExtension, fileExt) + const path = await this.guessVideoPathWithExtension(pathWithoutExtension, fileExt) - if (err) { - remove(path) - .catch(err => logger.error('Cannot delete path on YoutubeDL error.', { err })) + if (err) { + remove(path) + .catch(err => logger.error('Cannot delete path on YoutubeDL error.', { err })) + + return rej(err) + } + return res(path) + } catch (err) { return rej(err) } - - return res(path) - } catch (err) { - return rej(err) - } + }) + + timer = setTimeout(() => { + const err = new Error('YoutubeDL download timeout.') + + this.guessVideoPathWithExtension(pathWithoutExtension, fileExt) + .then(path => remove(path)) + .finally(() => rej(err)) + .catch(err => { + logger.error('Cannot remove file in youtubeDL timeout.', { err }) + return rej(err) + }) + }, timeout) }) + .catch(err => rej(err)) + }) + } - timer = setTimeout(() => { - const err = new Error('YoutubeDL download timeout.') - - guessVideoPathWithExtension(pathWithoutExtension, fileExt) - .then(path => remove(path)) - .finally(() => rej(err)) - .catch(err => { - logger.error('Cannot remove file in youtubeDL timeout.', { err }) - return rej(err) - }) - }, timeout) - }) - .catch(err => rej(err)) - }) -} + buildOriginallyPublishedAt (obj: any) { + let originallyPublishedAt: Date = null -// 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 uploadDateMatcher = /^(\d{4})(\d{2})(\d{2})$/.exec(obj.upload_date) + if (uploadDateMatcher) { + originallyPublishedAt = new Date() + originallyPublishedAt.setHours(0, 0, 0, 0) - const binDirectory = join(root(), 'node_modules', 'youtube-dl', 'bin') - const bin = join(binDirectory, 'youtube-dl') - const detailsPath = join(binDirectory, 'details') - const url = process.env.YOUTUBE_DL_DOWNLOAD_HOST || 'https://yt-dl.org/downloads/latest/youtube-dl' + const year = parseInt(uploadDateMatcher[1], 10) + // Month starts from 0 + const month = parseInt(uploadDateMatcher[2], 10) - 1 + const day = parseInt(uploadDateMatcher[3], 10) - await ensureDir(binDirectory) + originallyPublishedAt.setFullYear(year, month, day) + } - return new Promise(res => { - request.get(url, { followRedirect: false }, (err, result) => { - if (err) { - logger.error('Cannot update youtube-dl.', { err }) - return res() - } + return originallyPublishedAt + } - if (result.statusCode !== HttpStatusCode.FOUND_302) { - logger.error('youtube-dl update error: did not get redirect for the latest version link. Status %d', result.statusCode) - return res() - } + private async guessVideoPathWithExtension (tmpPath: string, sourceExt: string) { + if (!isVideoFileExtnameValid(sourceExt)) { + throw new Error('Invalid video extension ' + sourceExt) + } - 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] + const extensions = [ sourceExt, '.mp4', '.mkv', '.webm' ] - downloadFile.on('response', result => { - if (result.statusCode !== HttpStatusCode.OK_200) { - logger.error('Cannot update youtube-dl: new version response is not 200, it\'s %d.', result.statusCode) - return res() - } + for (const extension of extensions) { + const path = tmpPath + extension - const writeStream = createWriteStream(bin, { mode: 493 }).on('error', err => { - logger.error('youtube-dl update error in write stream', { err }) - return res() - }) + if (await pathExists(path)) return path + } - downloadFile.pipe(writeStream) - }) + throw new Error('Cannot guess path of ' + tmpPath) + } - downloadFile.on('error', err => { - logger.error('youtube-dl update error.', { err }) - return res() - }) + private normalizeObject (obj: any) { + const newObj: any = {} - 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() - } + for (const key of Object.keys(obj)) { + // Deprecated key + if (key === 'resolution') continue - logger.info('youtube-dl updated to version %s.', newVersion) - return res() - }) - }) - }) - }) -} + const value = obj[key] -async function safeGetYoutubeDL () { - let youtubeDL + if (typeof value === 'string') { + newObj[key] = value.normalize() + } else { + newObj[key] = value + } + } - try { - youtubeDL = require('youtube-dl') - } catch (e) { - // Download binary - await updateYoutubeDLBinary() - youtubeDL = require('youtube-dl') + return newObj } - return youtubeDL -} - -function buildOriginallyPublishedAt (obj: any) { - let originallyPublishedAt: Date = null - - 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) + private buildVideoInfo (obj: any): YoutubeDLInfo { + return { + name: this.titleTruncation(obj.title), + description: this.descriptionTruncation(obj.description), + category: this.getCategory(obj.categories), + licence: this.getLicence(obj.license), + language: this.getLanguage(obj.language), + nsfw: this.isNSFW(obj), + tags: this.getTags(obj.tags), + thumbnailUrl: obj.thumbnail || undefined, + originallyPublishedAt: this.buildOriginallyPublishedAt(obj), + ext: obj.ext + } + } - originallyPublishedAt.setFullYear(year, month, day) + private titleTruncation (title: string) { + return peertubeTruncate(title, { + length: CONSTRAINTS_FIELDS.VIDEOS.NAME.max, + separator: /,? +/, + omission: ' […]' + }) } - return originallyPublishedAt -} + private descriptionTruncation (description: string) { + if (!description || description.length < CONSTRAINTS_FIELDS.VIDEOS.DESCRIPTION.min) return undefined -// --------------------------------------------------------------------------- + return peertubeTruncate(description, { + length: CONSTRAINTS_FIELDS.VIDEOS.DESCRIPTION.max, + separator: /,? +/, + omission: ' […]' + }) + } -export { - updateYoutubeDLBinary, - getYoutubeDLVideoFormat, - downloadYoutubeDLVideo, - getYoutubeDLSubs, - getYoutubeDLInfo, - safeGetYoutubeDL, - buildOriginallyPublishedAt -} + private isNSFW (info: any) { + return info.age_limit && info.age_limit >= 16 + } -// --------------------------------------------------------------------------- + private getTags (tags: any) { + if (Array.isArray(tags) === false) return [] -async function guessVideoPathWithExtension (tmpPath: string, sourceExt: string) { - if (!isVideoFileExtnameValid(sourceExt)) { - throw new Error('Invalid video extension ' + sourceExt) + return tags + .filter(t => t.length < CONSTRAINTS_FIELDS.VIDEOS.TAG.max && t.length > CONSTRAINTS_FIELDS.VIDEOS.TAG.min) + .map(t => t.normalize()) + .slice(0, 5) } - const extensions = [ sourceExt, '.mp4', '.mkv', '.webm' ] + private getLicence (licence: string) { + if (!licence) return undefined - for (const extension of extensions) { - const path = tmpPath + extension + if (licence.includes('Creative Commons Attribution')) return 1 - if (await pathExists(path)) return path - } + for (const key of Object.keys(VIDEO_LICENCES)) { + const peertubeLicence = VIDEO_LICENCES[key] + if (peertubeLicence.toLowerCase() === licence.toLowerCase()) return parseInt(key, 10) + } - throw new Error('Cannot guess path of ' + tmpPath) -} + return undefined + } -function normalizeObject (obj: any) { - const newObj: any = {} + private getCategory (categories: string[]) { + if (!categories) return undefined - for (const key of Object.keys(obj)) { - // Deprecated key - if (key === 'resolution') continue + const categoryString = categories[0] + if (!categoryString || typeof categoryString !== 'string') return undefined - const value = obj[key] + if (categoryString === 'News & Politics') return 11 - if (typeof value === 'string') { - newObj[key] = value.normalize() - } else { - newObj[key] = value + for (const key of Object.keys(VIDEO_CATEGORIES)) { + const category = VIDEO_CATEGORIES[key] + if (categoryString.toLowerCase() === category.toLowerCase()) return parseInt(key, 10) } - } - return newObj -} - -function buildVideoInfo (obj: any): YoutubeDLInfo { - return { - name: titleTruncation(obj.title), - description: descriptionTruncation(obj.description), - category: getCategory(obj.categories), - licence: getLicence(obj.license), - language: getLanguage(obj.language), - nsfw: isNSFW(obj), - tags: getTags(obj.tags), - thumbnailUrl: obj.thumbnail || undefined, - originallyPublishedAt: buildOriginallyPublishedAt(obj), - ext: obj.ext + return undefined } -} -function titleTruncation (title: string) { - return peertubeTruncate(title, { - length: CONSTRAINTS_FIELDS.VIDEOS.NAME.max, - separator: /,? +/, - omission: ' […]' - }) -} + private getLanguage (language: string) { + return VIDEO_LANGUAGES[language] ? language : undefined + } -function descriptionTruncation (description: string) { - if (!description || description.length < CONSTRAINTS_FIELDS.VIDEOS.DESCRIPTION.min) return undefined + private wrapWithProxyOptions (options: string[]) { + if (CONFIG.IMPORT.VIDEOS.HTTP.PROXY.ENABLED) { + logger.debug('Using proxy for YoutubeDL') - return peertubeTruncate(description, { - length: CONSTRAINTS_FIELDS.VIDEOS.DESCRIPTION.max, - separator: /,? +/, - omission: ' […]' - }) -} + return [ '--proxy', CONFIG.IMPORT.VIDEOS.HTTP.PROXY.URL ].concat(options) + } -function isNSFW (info: any) { - return info.age_limit && info.age_limit >= 16 -} + return options + } -function getTags (tags: any) { - if (Array.isArray(tags) === false) return [] + // Thanks: https://github.com/przemyslawpluta/node-youtube-dl/blob/master/lib/downloader.js + // We rewrote it to avoid sync calls + static async updateYoutubeDLBinary () { + logger.info('Updating youtubeDL binary.') - return tags - .filter(t => t.length < CONSTRAINTS_FIELDS.VIDEOS.TAG.max && t.length > CONSTRAINTS_FIELDS.VIDEOS.TAG.min) - .map(t => t.normalize()) - .slice(0, 5) -} + const binDirectory = join(root(), 'node_modules', 'youtube-dl', 'bin') + const bin = join(binDirectory, 'youtube-dl') + const detailsPath = join(binDirectory, 'details') + const url = process.env.YOUTUBE_DL_DOWNLOAD_HOST || 'https://yt-dl.org/downloads/latest/youtube-dl' -function getLicence (licence: string) { - if (!licence) return undefined + await ensureDir(binDirectory) - if (licence.includes('Creative Commons Attribution')) return 1 + try { + const result = await got(url, { followRedirect: false }) - for (const key of Object.keys(VIDEO_LICENCES)) { - const peertubeLicence = VIDEO_LICENCES[key] - if (peertubeLicence.toLowerCase() === licence.toLowerCase()) return parseInt(key, 10) - } + if (result.statusCode !== HttpStatusCode.FOUND_302) { + logger.error('youtube-dl update error: did not get redirect for the latest version link. Status %d', result.statusCode) + return + } - return undefined -} + const newUrl = result.headers.location + const newVersion = /yt-dl\.org\/downloads\/(\d{4}\.\d\d\.\d\d(\.\d)?)\/youtube-dl/.exec(newUrl)[1] -function getCategory (categories: string[]) { - if (!categories) return undefined + const downloadFileStream = got.stream(newUrl) + const writeStream = createWriteStream(bin, { mode: 493 }) - const categoryString = categories[0] - if (!categoryString || typeof categoryString !== 'string') return undefined + await pipelinePromise( + downloadFileStream, + writeStream + ) - if (categoryString === 'News & Politics') return 11 + const details = JSON.stringify({ version: newVersion, path: bin, exec: 'youtube-dl' }) + await writeFile(detailsPath, details, { encoding: 'utf8' }) - for (const key of Object.keys(VIDEO_CATEGORIES)) { - const category = VIDEO_CATEGORIES[key] - if (categoryString.toLowerCase() === category.toLowerCase()) return parseInt(key, 10) + logger.info('youtube-dl updated to version %s.', newVersion) + } catch (err) { + logger.error('Cannot update youtube-dl.', { err }) + } } - return undefined -} - -function getLanguage (language: string) { - return VIDEO_LANGUAGES[language] ? language : undefined -} + static async safeGetYoutubeDL () { + let youtubeDL -function wrapWithProxyOptions (options: string[]) { - if (CONFIG.IMPORT.VIDEOS.HTTP.PROXY.ENABLED) { - logger.debug('Using proxy for YoutubeDL') + try { + youtubeDL = require('youtube-dl') + } catch (e) { + // Download binary + await this.updateYoutubeDLBinary() + youtubeDL = require('youtube-dl') + } - return [ '--proxy', CONFIG.IMPORT.VIDEOS.HTTP.PROXY.URL ].concat(options) + return youtubeDL } +} - return options +// --------------------------------------------------------------------------- + +export { + YoutubeDL }