PeerTube/server/helpers/webtorrent.ts

238 lines
8.2 KiB
TypeScript
Raw Normal View History

2021-08-27 14:32:44 +02:00
import { decode, encode } from 'bencode'
import createTorrent from 'create-torrent'
2021-08-18 09:14:51 +02:00
import { createWriteStream, ensureDir, readFile, remove, writeFile } from 'fs-extra'
2021-08-27 14:32:44 +02:00
import magnetUtil from 'magnet-uri'
import parseTorrent from 'parse-torrent'
import { dirname, join } from 'path'
2021-08-27 14:32:44 +02:00
import { pipeline } from 'stream'
import WebTorrent, { Instance, TorrentFile } from 'webtorrent'
import { isArray } from '@server/helpers/custom-validators/misc'
import { WEBSERVER } from '@server/initializers/constants'
Add support for saving video files to object storage (#4290) * Add support for saving video files to object storage * Add support for custom url generation on s3 stored files Uses two config keys to support url generation that doesn't directly go to (compatible s3). Can be used to generate urls to any cache server or CDN. * Upload files to s3 concurrently and delete originals afterwards * Only publish after move to object storage is complete * Use base url instead of url template * Fix mistyped config field * Add rudenmentary way to download before transcode * Implement Chocobozzz suggestions https://github.com/Chocobozzz/PeerTube/pull/4290#issuecomment-891670478 The remarks in question: Try to use objectStorage prefix instead of s3 prefix for your function/variables/config names Prefer to use a tree for the config: s3.streaming_playlists_bucket -> object_storage.streaming_playlists.bucket Use uppercase for config: S3.STREAMING_PLAYLISTS_BUCKETINFO.bucket -> OBJECT_STORAGE.STREAMING_PLAYLISTS.BUCKET (maybe BUCKET_NAME instead of BUCKET) I suggest to rename moveJobsRunning to pendingMovingJobs (or better, create a dedicated videoJobInfo table with a pendingMove & videoId columns so we could also use this table to track pending transcoding jobs) https://github.com/Chocobozzz/PeerTube/pull/4290/files#diff-3e26d41ca4bda1de8e1747af70ca2af642abcc1e9e0bfb94239ff2165acfbde5R19 uses a string instead of an integer I think we should store the origin object storage URL in fileUrl, without base_url injection. Instead, inject the base_url at "runtime" so admins can easily change this configuration without running a script to update DB URLs * Import correct function * Support multipart upload * Remove import of node 15.0 module stream/promises * Extend maximum upload job length Using the same value as for redundancy downloading seems logical * Use dynamic part size for really large uploads Also adds very small part size for local testing * Fix decreasePendingMove query * Resolve various PR comments * Move to object storage after optimize * Make upload size configurable and increase default * Prune webtorrent files that are stored in object storage * Move files after transcoding jobs * Fix federation * Add video path manager * Support move to external storage job in client * Fix live object storage tests Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-08-17 08:26:20 +02:00
import { generateTorrentFileName } from '@server/lib/paths'
import { VideoPathManager } from '@server/lib/video-path-manager'
2021-02-18 11:28:00 +01:00
import { MVideo } from '@server/types/models/video/video'
import { MVideoFile, MVideoFileRedundanciesOpt } from '@server/types/models/video/video-file'
import { MStreamingPlaylistVideo } from '@server/types/models/video/video-streaming-playlist'
import { CONFIG } from '../initializers/config'
import { promisify2 } from './core-utils'
import { sha1 } from '@shared/core-utils/crypto'
import { logger } from './logger'
import { generateVideoImportTmpPath } from './utils'
2021-02-18 11:28:00 +01:00
import { extractVideo } from './video'
const createTorrentPromise = promisify2<string, any, any>(createTorrent)
2018-08-06 17:13:39 +02:00
async function downloadWebTorrentVideo (target: { uri: string, torrentName?: string }, timeout: number) {
const id = target.uri || 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()
2021-08-27 14:32:44 +02:00
let file: TorrentFile
2018-08-06 17:13:39 +02:00
const torrentId = target.uri || 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
}
logger.debug('Got torrent from webtorrent %s.', id, { infoHash: torrent.infoHash })
2021-08-26 15:19:11 +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
})
2021-08-26 15:19:11 +02:00
pipeline(
file.createReadStream(),
writeStream,
2021-08-26 15:51:37 +02:00
err => {
if (err) rej(err)
}
2021-08-26 15:19:11 +02:00
)
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
})
}
2021-08-18 09:14:51 +02:00
function createTorrentAndSetInfoHash (videoOrPlaylist: MVideo | MStreamingPlaylistVideo, videoFile: MVideoFile) {
2021-02-18 11:28:00 +01: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 09:14:51 +02:00
announceList: buildAnnounceList(),
urlList: buildUrlList(video, videoFile)
}
2021-11-18 14:35:08 +01:00
return VideoPathManager.Instance.makeAvailableVideoFile(videoFile.withVideoOrPlaylist(videoOrPlaylist), async videoPath => {
2021-08-18 09:14:51 +02:00
const torrentContent = await createTorrentPromise(videoPath, options)
Add support for saving video files to object storage (#4290) * Add support for saving video files to object storage * Add support for custom url generation on s3 stored files Uses two config keys to support url generation that doesn't directly go to (compatible s3). Can be used to generate urls to any cache server or CDN. * Upload files to s3 concurrently and delete originals afterwards * Only publish after move to object storage is complete * Use base url instead of url template * Fix mistyped config field * Add rudenmentary way to download before transcode * Implement Chocobozzz suggestions https://github.com/Chocobozzz/PeerTube/pull/4290#issuecomment-891670478 The remarks in question: Try to use objectStorage prefix instead of s3 prefix for your function/variables/config names Prefer to use a tree for the config: s3.streaming_playlists_bucket -> object_storage.streaming_playlists.bucket Use uppercase for config: S3.STREAMING_PLAYLISTS_BUCKETINFO.bucket -> OBJECT_STORAGE.STREAMING_PLAYLISTS.BUCKET (maybe BUCKET_NAME instead of BUCKET) I suggest to rename moveJobsRunning to pendingMovingJobs (or better, create a dedicated videoJobInfo table with a pendingMove & videoId columns so we could also use this table to track pending transcoding jobs) https://github.com/Chocobozzz/PeerTube/pull/4290/files#diff-3e26d41ca4bda1de8e1747af70ca2af642abcc1e9e0bfb94239ff2165acfbde5R19 uses a string instead of an integer I think we should store the origin object storage URL in fileUrl, without base_url injection. Instead, inject the base_url at "runtime" so admins can easily change this configuration without running a script to update DB URLs * Import correct function * Support multipart upload * Remove import of node 15.0 module stream/promises * Extend maximum upload job length Using the same value as for redundancy downloading seems logical * Use dynamic part size for really large uploads Also adds very small part size for local testing * Fix decreasePendingMove query * Resolve various PR comments * Move to object storage after optimize * Make upload size configurable and increase default * Prune webtorrent files that are stored in object storage * Move files after transcoding jobs * Fix federation * Add video path manager * Support move to external storage job in client * Fix live object storage tests Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-08-17 08:26:20 +02:00
const torrentFilename = generateTorrentFileName(videoOrPlaylist, videoFile.resolution)
const torrentPath = join(CONFIG.STORAGE.TORRENTS_DIR, torrentFilename)
logger.info('Creating torrent %s.', torrentPath)
2021-08-18 09:14:51 +02:00
await writeFile(torrentPath, torrentContent)
Add support for saving video files to object storage (#4290) * Add support for saving video files to object storage * Add support for custom url generation on s3 stored files Uses two config keys to support url generation that doesn't directly go to (compatible s3). Can be used to generate urls to any cache server or CDN. * Upload files to s3 concurrently and delete originals afterwards * Only publish after move to object storage is complete * Use base url instead of url template * Fix mistyped config field * Add rudenmentary way to download before transcode * Implement Chocobozzz suggestions https://github.com/Chocobozzz/PeerTube/pull/4290#issuecomment-891670478 The remarks in question: Try to use objectStorage prefix instead of s3 prefix for your function/variables/config names Prefer to use a tree for the config: s3.streaming_playlists_bucket -> object_storage.streaming_playlists.bucket Use uppercase for config: S3.STREAMING_PLAYLISTS_BUCKETINFO.bucket -> OBJECT_STORAGE.STREAMING_PLAYLISTS.BUCKET (maybe BUCKET_NAME instead of BUCKET) I suggest to rename moveJobsRunning to pendingMovingJobs (or better, create a dedicated videoJobInfo table with a pendingMove & videoId columns so we could also use this table to track pending transcoding jobs) https://github.com/Chocobozzz/PeerTube/pull/4290/files#diff-3e26d41ca4bda1de8e1747af70ca2af642abcc1e9e0bfb94239ff2165acfbde5R19 uses a string instead of an integer I think we should store the origin object storage URL in fileUrl, without base_url injection. Instead, inject the base_url at "runtime" so admins can easily change this configuration without running a script to update DB URLs * Import correct function * Support multipart upload * Remove import of node 15.0 module stream/promises * Extend maximum upload job length Using the same value as for redundancy downloading seems logical * Use dynamic part size for really large uploads Also adds very small part size for local testing * Fix decreasePendingMove query * Resolve various PR comments * Move to object storage after optimize * Make upload size configurable and increase default * Prune webtorrent files that are stored in object storage * Move files after transcoding jobs * Fix federation * Add video path manager * Support move to external storage job in client * Fix live object storage tests Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-08-17 08:26:20 +02:00
// Remove old torrent file if it existed
if (videoFile.hasTorrent()) {
await remove(join(CONFIG.STORAGE.TORRENTS_DIR, videoFile.torrentFilename))
}
2021-07-23 11:20:00 +02:00
2021-08-18 09:14:51 +02:00
const parsedTorrent = parseTorrent(torrentContent)
Add support for saving video files to object storage (#4290) * Add support for saving video files to object storage * Add support for custom url generation on s3 stored files Uses two config keys to support url generation that doesn't directly go to (compatible s3). Can be used to generate urls to any cache server or CDN. * Upload files to s3 concurrently and delete originals afterwards * Only publish after move to object storage is complete * Use base url instead of url template * Fix mistyped config field * Add rudenmentary way to download before transcode * Implement Chocobozzz suggestions https://github.com/Chocobozzz/PeerTube/pull/4290#issuecomment-891670478 The remarks in question: Try to use objectStorage prefix instead of s3 prefix for your function/variables/config names Prefer to use a tree for the config: s3.streaming_playlists_bucket -> object_storage.streaming_playlists.bucket Use uppercase for config: S3.STREAMING_PLAYLISTS_BUCKETINFO.bucket -> OBJECT_STORAGE.STREAMING_PLAYLISTS.BUCKET (maybe BUCKET_NAME instead of BUCKET) I suggest to rename moveJobsRunning to pendingMovingJobs (or better, create a dedicated videoJobInfo table with a pendingMove & videoId columns so we could also use this table to track pending transcoding jobs) https://github.com/Chocobozzz/PeerTube/pull/4290/files#diff-3e26d41ca4bda1de8e1747af70ca2af642abcc1e9e0bfb94239ff2165acfbde5R19 uses a string instead of an integer I think we should store the origin object storage URL in fileUrl, without base_url injection. Instead, inject the base_url at "runtime" so admins can easily change this configuration without running a script to update DB URLs * Import correct function * Support multipart upload * Remove import of node 15.0 module stream/promises * Extend maximum upload job length Using the same value as for redundancy downloading seems logical * Use dynamic part size for really large uploads Also adds very small part size for local testing * Fix decreasePendingMove query * Resolve various PR comments * Move to object storage after optimize * Make upload size configurable and increase default * Prune webtorrent files that are stored in object storage * Move files after transcoding jobs * Fix federation * Add video path manager * Support move to external storage job in client * Fix live object storage tests Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-08-17 08:26:20 +02:00
videoFile.infoHash = parsedTorrent.infoHash
videoFile.torrentFilename = torrentFilename
})
}
async function updateTorrentMetadata (videoOrPlaylist: MVideo | MStreamingPlaylistVideo, videoFile: MVideoFile) {
2021-08-18 09:14:51 +02:00
const video = extractVideo(videoOrPlaylist)
const oldTorrentPath = join(CONFIG.STORAGE.TORRENTS_DIR, videoFile.torrentFilename)
const torrentContent = await readFile(oldTorrentPath)
2021-08-27 14:32:44 +02:00
const decoded = decode(torrentContent)
2021-08-18 09:14:51 +02: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 09:14:51 +02: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 09:14:51 +02:00
2021-08-27 14:32:44 +02:00
await writeFile(newTorrentPath, encode(decoded))
2021-08-18 09:33:48 +02:00
await remove(join(CONFIG.STORAGE.TORRENTS_DIR, videoFile.torrentFilename))
2021-08-18 09:14:51 +02:00
videoFile.torrentFilename = newTorrentFilename
videoFile.infoHash = sha1(encode(decoded.info))
2021-08-18 09:14:51 +02:00
}
function generateMagnetUri (
2021-02-18 11:28:00 +01:00
video: MVideo,
videoFile: MVideoFileRedundanciesOpt,
2021-02-18 10:15:11 +01:00
trackerUrls: string[]
) {
const xs = videoFile.getTorrentUrl()
2021-02-18 10:15:11 +01:00
const announce = trackerUrls
let urlList = [ 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
}
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,
updateTorrentMetadata,
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 (
2021-08-27 14:32:44 +02:00
webtorrent: Instance,
2018-09-28 09:08:12 +02:00
torrentId: string,
downloadedFile?: { directoryPath: string, filepath: string },
torrentName?: string
) {
2021-02-03 09:33:05 +01:00
return new Promise<void>(res => {
2018-09-11 16:27:07 +02:00
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 }))
}
2021-08-18 09:14:51 +02:00
function buildAnnounceList () {
return [
[ WEBSERVER.WS + '://' + WEBSERVER.HOSTNAME + ':' + WEBSERVER.PORT + '/tracker/socket' ],
[ WEBSERVER.URL + '/tracker/announce' ]
]
}
function buildUrlList (video: MVideo, videoFile: MVideoFile) {
return [ videoFile.getFileUrl(video) ]
}
function buildInfoName (video: MVideo, videoFile: MVideoFile) {
return `${video.name} ${videoFile.resolution}p${videoFile.extname}`
}