PeerTube/server/core/helpers/webtorrent.ts

270 lines
9.1 KiB
TypeScript
Raw Normal View History

import bencode from 'bencode'
2021-08-27 07:32:44 -05:00
import createTorrent from 'create-torrent'
import { createWriteStream } from 'fs'
import { ensureDir, pathExists, remove } from 'fs-extra/esm'
import { readFile, writeFile } from 'fs/promises'
2023-05-22 10:04:39 -05:00
import { encode as magnetUriEncode } from 'magnet-uri'
2021-08-27 07:32:44 -05:00
import parseTorrent from 'parse-torrent'
import { dirname, join } from 'path'
2021-08-27 07:32:44 -05:00
import { pipeline } from 'stream'
import { promisify2 } from '@peertube/peertube-core-utils'
import { isArray } from '@server/helpers/custom-validators/misc.js'
import { WEBSERVER } from '@server/initializers/constants.js'
import { generateTorrentFileName } from '@server/lib/paths.js'
import { VideoPathManager } from '@server/lib/video-path-manager.js'
import { MVideoFile, MVideoFileRedundanciesOpt } from '@server/types/models/video/video-file.js'
import { MStreamingPlaylistVideo } from '@server/types/models/video/video-streaming-playlist.js'
import { MVideo } from '@server/types/models/video/video.js'
import { sha1 } from '@peertube/peertube-node-utils'
import { CONFIG } from '../initializers/config.js'
import { logger } from './logger.js'
import { generateVideoImportTmpPath } from './utils.js'
import { extractVideo } from './video.js'
import type { Instance, TorrentFile } from 'webtorrent'
const createTorrentPromise = promisify2<string, any, any>(createTorrent)
2018-08-06 10:13:39 -05:00
async function downloadWebTorrentVideo (target: { uri: string, torrentName?: string }, timeout: number) {
const id = target.uri || target.torrentName
2018-09-11 09:27:07 -05:00
let timer
2018-08-06 10:13:39 -05:00
2018-12-04 09:02:49 -06:00
const path = generateVideoImportTmpPath(id)
2018-08-07 02:54:36 -05:00
logger.info('Importing torrent video %s', id)
2018-08-06 10:13:39 -05:00
2018-12-04 09:02:49 -06:00
const directoryPath = join(CONFIG.STORAGE.TMP_DIR, 'webtorrent')
await ensureDir(directoryPath)
// eslint-disable-next-line new-cap
const webtorrent = new (await import('webtorrent')).default({
natUpnp: false,
natPmp: false
} as any)
2018-08-06 10:13:39 -05:00
return new Promise<string>((res, rej) => {
2021-08-27 07:32:44 -05:00
let file: TorrentFile
2018-08-06 10:13:39 -05:00
const torrentId = target.uri || join(CONFIG.STORAGE.TORRENTS_DIR, target.torrentName)
2018-08-07 10:18:35 -05:00
const options = { path: directoryPath }
2018-08-07 10:18:35 -05:00
const torrent = webtorrent.add(torrentId, options, torrent => {
2018-09-11 09:27:07 -05:00
if (torrent.files.length !== 1) {
if (timer) clearTimeout(timer)
2018-08-06 10:13:39 -05:00
2020-01-31 09:56:52 -06:00
for (const file of torrent.files) {
2018-10-01 03:52:58 -05: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 09:27:07 -05:00
}
logger.debug('Got torrent from webtorrent %s.', id, { infoHash: torrent.infoHash })
2021-08-26 08:19:11 -05:00
2020-01-31 09:56:52 -06: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 09:56:52 -06:00
safeWebtorrentDestroy(webtorrent, torrentId, { directoryPath, filepath: file.path }, target.torrentName)
.then(() => res(path))
2020-01-31 09:56:52 -06:00
.catch(err => logger.error('Cannot destroy webtorrent.', { err }))
2018-09-25 12:42:05 -05:00
})
2021-08-26 08:19:11 -05:00
pipeline(
file.createReadStream(),
writeStream,
2021-08-26 08:51:37 -05:00
err => {
if (err) rej(err)
}
2021-08-26 08:19:11 -05:00
)
2018-08-07 08:17:17 -05:00
})
2018-08-06 10:13:39 -05:00
torrent.on('error', err => rej(err))
2018-09-11 09:27:07 -05:00
2020-01-31 09:56:52 -06: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 10:13:39 -05:00
})
}
2021-08-18 02:14:51 -05:00
function createTorrentAndSetInfoHash (videoOrPlaylist: MVideo | MStreamingPlaylistVideo, videoFile: MVideoFile) {
2022-02-11 03:51:33 -06:00
return VideoPathManager.Instance.makeAvailableVideoFile(videoFile.withVideoOrPlaylist(videoOrPlaylist), videoPath => {
return createTorrentAndSetInfoHashFromPath(videoOrPlaylist, videoFile, videoPath)
})
}
async function createTorrentAndSetInfoHashFromPath (
videoOrPlaylist: MVideo | MStreamingPlaylistVideo,
videoFile: MVideoFile,
filePath: string
) {
2021-02-18 04:28:00 -06:00
const video = extractVideo(videoOrPlaylist)
const options = {
// Keep the extname, it's used by the client to stream the file inside a web browser
name: buildInfoName(video, videoFile),
createdBy: 'PeerTube',
2021-08-18 02:14:51 -05:00
announceList: buildAnnounceList(),
urlList: buildUrlList(video, videoFile)
}
2022-02-11 03:51:33 -06:00
const torrentContent = await createTorrentPromise(filePath, options)
2022-02-11 03:51:33 -06:00
const torrentFilename = generateTorrentFileName(videoOrPlaylist, videoFile.resolution)
const torrentPath = join(CONFIG.STORAGE.TORRENTS_DIR, torrentFilename)
logger.info('Creating torrent %s.', torrentPath)
2022-02-11 03:51:33 -06:00
await writeFile(torrentPath, torrentContent)
2022-02-11 03:51:33 -06:00
// Remove old torrent file if it existed
if (videoFile.hasTorrent()) {
await remove(join(CONFIG.STORAGE.TORRENTS_DIR, videoFile.torrentFilename))
}
2021-07-23 04:20:00 -05:00
2023-10-11 02:20:23 -05:00
// FIXME: typings: parseTorrent now returns an async result
const parsedTorrent = await (parseTorrent(torrentContent) as unknown as Promise<parseTorrent.Instance>)
2022-02-11 03:51:33 -06:00
videoFile.infoHash = parsedTorrent.infoHash
videoFile.torrentFilename = torrentFilename
}
async function updateTorrentMetadata (videoOrPlaylist: MVideo | MStreamingPlaylistVideo, videoFile: MVideoFile) {
2021-08-18 02:14:51 -05:00
const video = extractVideo(videoOrPlaylist)
const oldTorrentPath = join(CONFIG.STORAGE.TORRENTS_DIR, videoFile.torrentFilename)
2022-10-26 03:55:12 -05:00
if (!await pathExists(oldTorrentPath)) {
logger.info('Do not update torrent metadata %s of video %s because the file does not exist anymore.', video.uuid, oldTorrentPath)
return
}
2021-08-18 02:14:51 -05:00
const torrentContent = await readFile(oldTorrentPath)
const decoded = bencode.decode(torrentContent)
2021-08-18 02:14:51 -05:00
decoded['announce-list'] = buildAnnounceList()
decoded.announce = decoded['announce-list'][0][0]
decoded['url-list'] = buildUrlList(video, videoFile)
decoded.info.name = buildInfoName(video, videoFile)
decoded['creation date'] = Math.ceil(Date.now() / 1000)
2021-08-18 02:14:51 -05:00
const newTorrentFilename = generateTorrentFileName(videoOrPlaylist, videoFile.resolution)
const newTorrentPath = join(CONFIG.STORAGE.TORRENTS_DIR, newTorrentFilename)
logger.info('Updating torrent metadata %s -> %s.', oldTorrentPath, newTorrentPath)
2021-08-18 02:14:51 -05:00
await writeFile(newTorrentPath, bencode.encode(decoded))
2022-10-26 03:55:12 -05:00
await remove(oldTorrentPath)
2021-08-18 02:14:51 -05:00
videoFile.torrentFilename = newTorrentFilename
videoFile.infoHash = sha1(bencode.encode(decoded.info))
2021-08-18 02:14:51 -05:00
}
function generateMagnetUri (
2021-02-18 04:28:00 -06:00
video: MVideo,
videoFile: MVideoFileRedundanciesOpt,
2021-02-18 03:15:11 -06:00
trackerUrls: string[]
) {
const xs = videoFile.getTorrentUrl()
2021-02-18 03:15:11 -06:00
const announce = trackerUrls
let urlList = video.hasPrivateStaticPath()
? []
: [ videoFile.getFileUrl(video) ]
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
}
2023-05-22 10:04:39 -05:00
return magnetUriEncode(magnetHash)
}
2019-07-15 02:22:57 -05:00
2018-08-06 10:13:39 -05:00
// ---------------------------------------------------------------------------
export {
2019-11-21 09:30:47 -06:00
createTorrentPromise,
updateTorrentMetadata,
2022-02-11 03:51:33 -06:00
createTorrentAndSetInfoHash,
2022-02-11 03:51:33 -06:00
createTorrentAndSetInfoHashFromPath,
generateMagnetUri,
2018-08-06 10:13:39 -05:00
downloadWebTorrentVideo
}
2018-09-11 09:27:07 -05:00
// ---------------------------------------------------------------------------
2018-09-28 02:08:12 -05:00
function safeWebtorrentDestroy (
2021-08-27 07:32:44 -05:00
webtorrent: Instance,
2018-09-28 02:08:12 -05:00
torrentId: string,
downloadedFile?: { directoryPath: string, filepath: string },
torrentName?: string
) {
2021-02-03 02:33:05 -06:00
return new Promise<void>(res => {
2018-09-11 09:27:07 -05:00
webtorrent.destroy(err => {
// Delete torrent file
if (torrentName) {
2018-09-28 02:08:12 -05:00
logger.debug('Removing %s torrent after webtorrent download.', torrentId)
2018-09-11 09:27:07 -05:00
remove(torrentId)
.catch(err => logger.error('Cannot remove torrent %s in webtorrent download.', torrentId, { err }))
}
// Delete downloaded file
2018-10-01 03:52:58 -05:00
if (downloadedFile) deleteDownloadedFile(downloadedFile)
2018-09-11 09:27:07 -05:00
2018-10-01 03:52:58 -05:00
if (err) logger.warn('Cannot destroy webtorrent in timeout.', { err })
2018-09-11 09:27:07 -05:00
return res()
})
})
}
2018-10-01 03:52:58 -05: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 }))
}
2021-08-18 02:14:51 -05:00
function buildAnnounceList () {
return [
[ WEBSERVER.WS + '://' + WEBSERVER.HOSTNAME + ':' + WEBSERVER.PORT + '/tracker/socket' ],
[ WEBSERVER.URL + '/tracker/announce' ]
]
}
function buildUrlList (video: MVideo, videoFile: MVideoFile) {
if (video.hasPrivateStaticPath()) return []
2021-08-18 02:14:51 -05:00
return [ videoFile.getFileUrl(video) ]
}
function buildInfoName (video: MVideo, videoFile: MVideoFile) {
const videoName = video.name.replace(/[/\\?%*:|"<>]/g, '-')
return `${videoName} ${videoFile.resolution}p${videoFile.extname}`
}