Init commit
This commit is contained in:
ShreejitPanchal
258
server/core/lib/webtorrent.ts
Normal file
258
server/core/lib/webtorrent.ts
Normal file
@@ -0,0 +1,258 @@
|
||||
import { sha1 } from '@peertube/peertube-node-utils'
|
||||
import { WEBSERVER } from '@server/initializers/constants.js'
|
||||
import { generateTorrentFileName } from '@server/lib/paths.js'
|
||||
import { VideoPathManager } from '@server/lib/video-path-manager.js'
|
||||
import { createTorrentFromWorker } from '@server/lib/worker/parent-process.js'
|
||||
import { MVideoFile } 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 bencode from 'bencode'
|
||||
import { createWriteStream } from 'fs'
|
||||
import { ensureDir, pathExists, remove } from 'fs-extra/esm'
|
||||
import { readFile, writeFile } from 'fs/promises'
|
||||
import { encode as magnetUriEncode } from 'magnet-uri'
|
||||
import parseTorrent from 'parse-torrent'
|
||||
import { dirname, join } from 'path'
|
||||
import { pipeline } from 'stream'
|
||||
import type { Instance, TorrentFile } from 'webtorrent'
|
||||
import { logger } from '../helpers/logger.js'
|
||||
import { generateVideoImportTmpPath } from '../helpers/utils.js'
|
||||
import { extractVideo } from '../helpers/video.js'
|
||||
import { CONFIG } from '../initializers/config.js'
|
||||
|
||||
export async function downloadWebTorrentVideo (target: { uri: string, torrentName?: string }, timeout: number) {
|
||||
const id = target.uri || target.torrentName
|
||||
let timer
|
||||
|
||||
const path = generateVideoImportTmpPath(id)
|
||||
logger.info('Importing torrent video %s', id)
|
||||
|
||||
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,
|
||||
utp: false,
|
||||
lsd: false,
|
||||
downloadLimit: 5_000_000,
|
||||
uploadLimit: 5_000_000
|
||||
} as any)
|
||||
|
||||
return new Promise<string>((res, rej) => {
|
||||
let file: TorrentFile
|
||||
|
||||
const torrentId = target.uri || join(CONFIG.STORAGE.TORRENTS_DIR, target.torrentName)
|
||||
|
||||
const options = { path: directoryPath }
|
||||
const torrent = webtorrent.add(torrentId, options, torrent => {
|
||||
if (torrent.files.length !== 1) {
|
||||
if (timer) clearTimeout(timer)
|
||||
|
||||
for (const file of torrent.files) {
|
||||
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')))
|
||||
}
|
||||
|
||||
logger.debug('Got torrent from webtorrent %s.', id, { infoHash: torrent.infoHash })
|
||||
|
||||
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)
|
||||
|
||||
safeWebtorrentDestroy(webtorrent, torrentId, { directoryPath, filepath: file.path }, target.torrentName)
|
||||
.then(() => res(path))
|
||||
.catch(err => logger.error('Cannot destroy webtorrent.', { err }))
|
||||
})
|
||||
|
||||
pipeline(
|
||||
file.createReadStream(),
|
||||
writeStream,
|
||||
err => {
|
||||
if (err) rej(err)
|
||||
}
|
||||
)
|
||||
})
|
||||
|
||||
torrent.on('error', err => rej(err))
|
||||
|
||||
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)
|
||||
})
|
||||
}
|
||||
|
||||
export function createTorrentAndSetInfoHash (videoOrPlaylist: MVideo | MStreamingPlaylistVideo, videoFile: MVideoFile) {
|
||||
return VideoPathManager.Instance.makeAvailableVideoFile(videoFile.withVideoOrPlaylist(videoOrPlaylist), videoPath => {
|
||||
return createTorrentAndSetInfoHashFromPath(videoOrPlaylist, videoFile, videoPath)
|
||||
})
|
||||
}
|
||||
|
||||
export async function createTorrentAndSetInfoHashFromPath (
|
||||
videoOrPlaylist: MVideo | MStreamingPlaylistVideo,
|
||||
videoFile: MVideoFile,
|
||||
filePath: string
|
||||
) {
|
||||
const video = extractVideo(videoOrPlaylist)
|
||||
|
||||
const torrentContent = await createTorrentFromWorker({
|
||||
path: filePath,
|
||||
|
||||
// Keep the extname, it's used by the client to stream the file inside a web browser
|
||||
name: buildInfoName(video, videoFile),
|
||||
createdBy: 'PeerTube',
|
||||
announceList: buildAnnounceList(),
|
||||
urlList: buildUrlList(video, videoFile)
|
||||
})
|
||||
|
||||
const torrentFilename = generateTorrentFileName(videoOrPlaylist, videoFile.resolution)
|
||||
const torrentPath = join(CONFIG.STORAGE.TORRENTS_DIR, torrentFilename)
|
||||
logger.info('Creating torrent %s.', torrentPath)
|
||||
|
||||
await writeFile(torrentPath, torrentContent)
|
||||
|
||||
// Remove old torrent file if it existed
|
||||
if (videoFile.hasTorrent()) {
|
||||
await remove(join(CONFIG.STORAGE.TORRENTS_DIR, videoFile.torrentFilename))
|
||||
}
|
||||
|
||||
// FIXME: typings: parseTorrent now returns an async result
|
||||
const parsedTorrent = await (parseTorrent(torrentContent) as unknown as Promise<parseTorrent.Instance>)
|
||||
videoFile.infoHash = parsedTorrent.infoHash
|
||||
videoFile.torrentFilename = torrentFilename
|
||||
}
|
||||
|
||||
export async function updateTorrentMetadata (videoOrPlaylist: MVideo | MStreamingPlaylistVideo, videoFile: MVideoFile) {
|
||||
const video = extractVideo(videoOrPlaylist)
|
||||
|
||||
if (!videoFile.torrentFilename) {
|
||||
logger.error(`Video file ${videoFile.filename} of video ${video.uuid} doesn't have a torrent file, skipping torrent metadata update`)
|
||||
return
|
||||
}
|
||||
|
||||
const oldTorrentPath = join(CONFIG.STORAGE.TORRENTS_DIR, videoFile.torrentFilename)
|
||||
|
||||
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
|
||||
}
|
||||
|
||||
const torrentContent = await readFile(oldTorrentPath)
|
||||
const decoded = bencode.decode(torrentContent)
|
||||
|
||||
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)
|
||||
|
||||
const newTorrentFilename = generateTorrentFileName(videoOrPlaylist, videoFile.resolution)
|
||||
const newTorrentPath = join(CONFIG.STORAGE.TORRENTS_DIR, newTorrentFilename)
|
||||
|
||||
logger.info('Updating torrent metadata %s -> %s.', oldTorrentPath, newTorrentPath)
|
||||
|
||||
await writeFile(newTorrentPath, bencode.encode(decoded))
|
||||
await remove(oldTorrentPath)
|
||||
|
||||
videoFile.torrentFilename = newTorrentFilename
|
||||
videoFile.infoHash = sha1(bencode.encode(decoded.info))
|
||||
}
|
||||
|
||||
export function generateMagnetUri (
|
||||
video: MVideo,
|
||||
videoFile: MVideoFile,
|
||||
trackerUrls: string[]
|
||||
) {
|
||||
const xs = videoFile.getTorrentUrl()
|
||||
const announce = trackerUrls
|
||||
|
||||
const urlList = video.hasPrivateStaticPath()
|
||||
? []
|
||||
: [ videoFile.getFileUrl(video) ]
|
||||
|
||||
const magnetHash = {
|
||||
xs,
|
||||
announce,
|
||||
urlList,
|
||||
infoHash: videoFile.infoHash,
|
||||
name: video.name
|
||||
}
|
||||
|
||||
return magnetUriEncode(magnetHash)
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Private
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
function safeWebtorrentDestroy (
|
||||
webtorrent: Instance,
|
||||
torrentId: string,
|
||||
downloadedFile?: { directoryPath: string, filepath: string },
|
||||
torrentName?: string
|
||||
) {
|
||||
return new Promise<void>(res => {
|
||||
webtorrent.destroy(err => {
|
||||
// Delete torrent file
|
||||
if (torrentName) {
|
||||
logger.debug('Removing %s torrent after webtorrent download.', torrentId)
|
||||
remove(torrentId)
|
||||
.catch(err => logger.error('Cannot remove torrent %s in webtorrent download.', torrentId, { err }))
|
||||
}
|
||||
|
||||
// Delete downloaded file
|
||||
if (downloadedFile) deleteDownloadedFile(downloadedFile)
|
||||
|
||||
if (err) logger.warn('Cannot destroy webtorrent in timeout.', { err })
|
||||
|
||||
return res()
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
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 }))
|
||||
}
|
||||
|
||||
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 []
|
||||
|
||||
return [ videoFile.getFileUrl(video) ]
|
||||
}
|
||||
|
||||
function buildInfoName (video: MVideo, videoFile: MVideoFile) {
|
||||
const videoName = video.name.replace(/[/\\?%*:|"<>]/g, '-')
|
||||
|
||||
return `${videoName} ${videoFile.resolution}p${videoFile.extname}`
|
||||
}
|
||||
Reference in New Issue
Block a user