PeerTube/server/helpers/webtorrent.ts

182 lines
6.4 KiB
TypeScript
Raw Normal View History

2018-08-06 17:13:39 +02:00
import { logger } from './logger'
2018-12-04 16:02:49 +01:00
import { generateVideoImportTmpPath } from './utils'
2018-08-06 17:13:39 +02:00
import * as WebTorrent from 'webtorrent'
import { createWriteStream, ensureDir, remove, writeFile } from 'fs-extra'
2019-04-11 11:33:44 +02:00
import { CONFIG } from '../initializers/config'
2018-09-28 09:08:12 +02:00
import { dirname, join } from 'path'
2019-07-15 09:22:57 +02:00
import * as createTorrent from 'create-torrent'
import { promisify2 } from './core-utils'
import { MVideo } from '@server/typings/models/video/video'
import { MVideoFile, MVideoFileRedundanciesOpt } from '@server/typings/models/video/video-file'
import { isStreamingPlaylist, MStreamingPlaylistVideo } from '@server/typings/models/video/video-streaming-playlist'
2020-01-10 10:11:28 +01:00
import { WEBSERVER } from '@server/initializers/constants'
import * as parseTorrent from 'parse-torrent'
import * as magnetUtil from 'magnet-uri'
import { isArray } from '@server/helpers/custom-validators/misc'
2020-01-10 10:11:28 +01:00
import { getTorrentFileName, getVideoFilePath } from '@server/lib/video-paths'
2020-04-23 09:32:53 +02:00
import { extractVideo } from '@server/helpers/video'
const createTorrentPromise = promisify2<string, any, any>(createTorrent)
2018-08-06 17:13:39 +02:00
async function downloadWebTorrentVideo (target: { magnetUri: string, torrentName?: string }, timeout: number) {
2018-08-07 09:54:36 +02:00
const id = target.magnetUri || target.torrentName
2018-09-11 16:27:07 +02:00
let timer
2018-08-06 17:13:39 +02:00
2018-12-04 16:02:49 +01:00
const path = generateVideoImportTmpPath(id)
2018-08-07 09:54:36 +02:00
logger.info('Importing torrent video %s', id)
2018-08-06 17:13:39 +02:00
2018-12-04 16:02:49 +01:00
const directoryPath = join(CONFIG.STORAGE.TMP_DIR, 'webtorrent')
await ensureDir(directoryPath)
2018-08-06 17:13:39 +02:00
return new Promise<string>((res, rej) => {
const webtorrent = new WebTorrent()
2018-09-11 16:27:07 +02:00
let file: WebTorrent.TorrentFile
2018-08-06 17:13:39 +02:00
2018-08-07 09:54:36 +02:00
const torrentId = target.magnetUri || join(CONFIG.STORAGE.TORRENTS_DIR, target.torrentName)
2018-08-07 17:18:35 +02:00
const options = { path: directoryPath }
2018-08-07 17:18:35 +02:00
const torrent = webtorrent.add(torrentId, options, torrent => {
2018-09-11 16:27:07 +02:00
if (torrent.files.length !== 1) {
if (timer) clearTimeout(timer)
2018-08-06 17:13:39 +02:00
2020-01-31 16:56:52 +01:00
for (const file of torrent.files) {
2018-10-01 10:52:58 +02:00
deleteDownloadedFile({ directoryPath, filepath: file.path })
}
return safeWebtorrentDestroy(webtorrent, torrentId, undefined, target.torrentName)
.then(() => rej(new Error('Cannot import torrent ' + torrentId + ': there are multiple files in it')))
2018-09-11 16:27:07 +02:00
}
2020-01-31 16:56:52 +01:00
file = torrent.files[0]
// FIXME: avoid creating another stream when https://github.com/webtorrent/webtorrent/issues/1517 is fixed
const writeStream = createWriteStream(path)
writeStream.on('finish', () => {
if (timer) clearTimeout(timer)
2020-01-31 16:56:52 +01:00
safeWebtorrentDestroy(webtorrent, torrentId, { directoryPath, filepath: file.path }, target.torrentName)
.then(() => res(path))
2020-01-31 16:56:52 +01:00
.catch(err => logger.error('Cannot destroy webtorrent.', { err }))
2018-09-25 19:42:05 +02:00
})
file.createReadStream().pipe(writeStream)
2018-08-07 15:17:17 +02:00
})
2018-08-06 17:13:39 +02:00
torrent.on('error', err => rej(err))
2018-09-11 16:27:07 +02:00
2020-01-31 16:56:52 +01:00
timer = setTimeout(() => {
const err = new Error('Webtorrent download timeout.')
safeWebtorrentDestroy(webtorrent, torrentId, file ? { directoryPath, filepath: file.path } : undefined, target.torrentName)
.then(() => rej(err))
.catch(destroyErr => {
logger.error('Cannot destroy webtorrent.', { err: destroyErr })
rej(err)
})
}, timeout)
2018-08-06 17:13:39 +02:00
})
}
async function createTorrentAndSetInfoHash (videoOrPlaylist: MVideo | MStreamingPlaylistVideo, videoFile: MVideoFile) {
const video = extractVideo(videoOrPlaylist)
2019-11-21 16:30:47 +01:00
const { baseUrlHttp } = video.getBaseUrls()
const options = {
// Keep the extname, it's used by the client to stream the file inside a web browser
name: `${video.name} ${videoFile.resolution}p${videoFile.extname}`,
createdBy: 'PeerTube',
announceList: [
[ WEBSERVER.WS + '://' + WEBSERVER.HOSTNAME + ':' + WEBSERVER.PORT + '/tracker/socket' ],
[ WEBSERVER.URL + '/tracker/announce' ]
],
2019-11-21 16:30:47 +01:00
urlList: [ videoOrPlaylist.getVideoFileUrl(videoFile, baseUrlHttp) ]
}
const torrent = await createTorrentPromise(getVideoFilePath(videoOrPlaylist, videoFile), options)
const filePath = join(CONFIG.STORAGE.TORRENTS_DIR, getTorrentFileName(videoOrPlaylist, videoFile))
logger.info('Creating torrent %s.', filePath)
await writeFile(filePath, torrent)
const parsedTorrent = parseTorrent(torrent)
videoFile.infoHash = parsedTorrent.infoHash
}
function generateMagnetUri (
videoOrPlaylist: MVideo | MStreamingPlaylistVideo,
videoFile: MVideoFileRedundanciesOpt,
baseUrlHttp: string,
baseUrlWs: string
) {
const video = isStreamingPlaylist(videoOrPlaylist)
? videoOrPlaylist.Video
: videoOrPlaylist
const xs = videoOrPlaylist.getTorrentUrl(videoFile, baseUrlHttp)
const announce = videoOrPlaylist.getTrackerUrls(baseUrlHttp, baseUrlWs)
let urlList = [ videoOrPlaylist.getVideoFileUrl(videoFile, baseUrlHttp) ]
const redundancies = videoFile.RedundancyVideos
if (isArray(redundancies)) urlList = urlList.concat(redundancies.map(r => r.fileUrl))
const magnetHash = {
xs,
announce,
urlList,
infoHash: videoFile.infoHash,
name: video.name
}
return magnetUtil.encode(magnetHash)
}
2019-07-15 09:22:57 +02:00
2018-08-06 17:13:39 +02:00
// ---------------------------------------------------------------------------
export {
2019-11-21 16:30:47 +01:00
createTorrentPromise,
createTorrentAndSetInfoHash,
generateMagnetUri,
2018-08-06 17:13:39 +02:00
downloadWebTorrentVideo
}
2018-09-11 16:27:07 +02:00
// ---------------------------------------------------------------------------
2018-09-28 09:08:12 +02:00
function safeWebtorrentDestroy (
webtorrent: WebTorrent.Instance,
torrentId: string,
downloadedFile?: { directoryPath: string, filepath: string },
torrentName?: string
) {
2018-09-11 16:27:07 +02:00
return new Promise(res => {
webtorrent.destroy(err => {
// Delete torrent file
if (torrentName) {
2018-09-28 09:08:12 +02:00
logger.debug('Removing %s torrent after webtorrent download.', torrentId)
2018-09-11 16:27:07 +02:00
remove(torrentId)
.catch(err => logger.error('Cannot remove torrent %s in webtorrent download.', torrentId, { err }))
}
// Delete downloaded file
2018-10-01 10:52:58 +02:00
if (downloadedFile) deleteDownloadedFile(downloadedFile)
2018-09-11 16:27:07 +02:00
2018-10-01 10:52:58 +02:00
if (err) logger.warn('Cannot destroy webtorrent in timeout.', { err })
2018-09-11 16:27:07 +02:00
return res()
})
})
}
2018-10-01 10:52:58 +02:00
function deleteDownloadedFile (downloadedFile: { directoryPath: string, filepath: string }) {
// We want to delete the base directory
let pathToDelete = dirname(downloadedFile.filepath)
if (pathToDelete === '.') pathToDelete = downloadedFile.filepath
const toRemovePath = join(downloadedFile.directoryPath, pathToDelete)
logger.debug('Removing %s after webtorrent download.', toRemovePath)
remove(toRemovePath)
.catch(err => logger.error('Cannot remove torrent file %s in webtorrent download.', toRemovePath, { err }))
}