1 import { decode, encode } from 'bencode'
2 import createTorrent from 'create-torrent'
3 import { createWriteStream, ensureDir, readFile, remove, writeFile } from 'fs-extra'
4 import magnetUtil from 'magnet-uri'
5 import parseTorrent from 'parse-torrent'
6 import { dirname, join } from 'path'
7 import { pipeline } from 'stream'
8 import WebTorrent, { Instance, TorrentFile } from 'webtorrent'
9 import { isArray } from '@server/helpers/custom-validators/misc'
10 import { WEBSERVER } from '@server/initializers/constants'
11 import { generateTorrentFileName } from '@server/lib/paths'
12 import { VideoPathManager } from '@server/lib/video-path-manager'
13 import { MVideo } from '@server/types/models/video/video'
14 import { MVideoFile, MVideoFileRedundanciesOpt } from '@server/types/models/video/video-file'
15 import { MStreamingPlaylistVideo } from '@server/types/models/video/video-streaming-playlist'
16 import { CONFIG } from '../initializers/config'
17 import { promisify2 } from './core-utils'
18 import { logger } from './logger'
19 import { generateVideoImportTmpPath } from './utils'
20 import { extractVideo } from './video'
22 const createTorrentPromise = promisify2<string, any, any>(createTorrent)
24 async function downloadWebTorrentVideo (target: { uri: string, torrentName?: string }, timeout: number) {
25 const id = target.uri || target.torrentName
28 const path = generateVideoImportTmpPath(id)
29 logger.info('Importing torrent video %s', id)
31 const directoryPath = join(CONFIG.STORAGE.TMP_DIR, 'webtorrent')
32 await ensureDir(directoryPath)
34 return new Promise<string>((res, rej) => {
35 const webtorrent = new WebTorrent()
38 const torrentId = target.uri || join(CONFIG.STORAGE.TORRENTS_DIR, target.torrentName)
40 const options = { path: directoryPath }
41 const torrent = webtorrent.add(torrentId, options, torrent => {
42 if (torrent.files.length !== 1) {
43 if (timer) clearTimeout(timer)
45 for (const file of torrent.files) {
46 deleteDownloadedFile({ directoryPath, filepath: file.path })
49 return safeWebtorrentDestroy(webtorrent, torrentId, undefined, target.torrentName)
50 .then(() => rej(new Error('Cannot import torrent ' + torrentId + ': there are multiple files in it')))
53 logger.debug('Got torrent from webtorrent %s.', id, { infoHash: torrent.infoHash })
55 file = torrent.files[0]
57 // FIXME: avoid creating another stream when https://github.com/webtorrent/webtorrent/issues/1517 is fixed
58 const writeStream = createWriteStream(path)
59 writeStream.on('finish', () => {
60 if (timer) clearTimeout(timer)
62 safeWebtorrentDestroy(webtorrent, torrentId, { directoryPath, filepath: file.path }, target.torrentName)
63 .then(() => res(path))
64 .catch(err => logger.error('Cannot destroy webtorrent.', { err }))
68 file.createReadStream(),
76 torrent.on('error', err => rej(err))
78 timer = setTimeout(() => {
79 const err = new Error('Webtorrent download timeout.')
81 safeWebtorrentDestroy(webtorrent, torrentId, file ? { directoryPath, filepath: file.path } : undefined, target.torrentName)
83 .catch(destroyErr => {
84 logger.error('Cannot destroy webtorrent.', { err: destroyErr })
92 function createTorrentAndSetInfoHash (videoOrPlaylist: MVideo | MStreamingPlaylistVideo, videoFile: MVideoFile) {
93 const video = extractVideo(videoOrPlaylist)
96 // Keep the extname, it's used by the client to stream the file inside a web browser
97 name: `${video.name} ${videoFile.resolution}p${videoFile.extname}`,
98 createdBy: 'PeerTube',
99 announceList: buildAnnounceList(),
100 urlList: buildUrlList(video, videoFile)
103 return VideoPathManager.Instance.makeAvailableVideoFile(videoFile.withVideoOrPlaylist(videoOrPlaylist), async videoPath => {
104 const torrentContent = await createTorrentPromise(videoPath, options)
106 const torrentFilename = generateTorrentFileName(videoOrPlaylist, videoFile.resolution)
107 const torrentPath = join(CONFIG.STORAGE.TORRENTS_DIR, torrentFilename)
108 logger.info('Creating torrent %s.', torrentPath)
110 await writeFile(torrentPath, torrentContent)
112 // Remove old torrent file if it existed
113 if (videoFile.hasTorrent()) {
114 await remove(join(CONFIG.STORAGE.TORRENTS_DIR, videoFile.torrentFilename))
117 const parsedTorrent = parseTorrent(torrentContent)
118 videoFile.infoHash = parsedTorrent.infoHash
119 videoFile.torrentFilename = torrentFilename
123 async function updateTorrentUrls (videoOrPlaylist: MVideo | MStreamingPlaylistVideo, videoFile: MVideoFile) {
124 const video = extractVideo(videoOrPlaylist)
126 const oldTorrentPath = join(CONFIG.STORAGE.TORRENTS_DIR, videoFile.torrentFilename)
128 const torrentContent = await readFile(oldTorrentPath)
129 const decoded = decode(torrentContent)
131 decoded['announce-list'] = buildAnnounceList()
132 decoded.announce = decoded['announce-list'][0][0]
134 decoded['url-list'] = buildUrlList(video, videoFile)
136 const newTorrentFilename = generateTorrentFileName(videoOrPlaylist, videoFile.resolution)
137 const newTorrentPath = join(CONFIG.STORAGE.TORRENTS_DIR, newTorrentFilename)
139 logger.info('Updating torrent URLs %s -> %s.', oldTorrentPath, newTorrentPath)
141 await writeFile(newTorrentPath, encode(decoded))
142 await remove(join(CONFIG.STORAGE.TORRENTS_DIR, videoFile.torrentFilename))
144 videoFile.torrentFilename = newTorrentFilename
147 function generateMagnetUri (
149 videoFile: MVideoFileRedundanciesOpt,
150 trackerUrls: string[]
152 const xs = videoFile.getTorrentUrl()
153 const announce = trackerUrls
154 let urlList = [ videoFile.getFileUrl(video) ]
156 const redundancies = videoFile.RedundancyVideos
157 if (isArray(redundancies)) urlList = urlList.concat(redundancies.map(r => r.fileUrl))
163 infoHash: videoFile.infoHash,
167 return magnetUtil.encode(magnetHash)
170 // ---------------------------------------------------------------------------
173 createTorrentPromise,
175 createTorrentAndSetInfoHash,
177 downloadWebTorrentVideo
180 // ---------------------------------------------------------------------------
182 function safeWebtorrentDestroy (
183 webtorrent: Instance,
185 downloadedFile?: { directoryPath: string, filepath: string },
188 return new Promise<void>(res => {
189 webtorrent.destroy(err => {
190 // Delete torrent file
192 logger.debug('Removing %s torrent after webtorrent download.', torrentId)
194 .catch(err => logger.error('Cannot remove torrent %s in webtorrent download.', torrentId, { err }))
197 // Delete downloaded file
198 if (downloadedFile) deleteDownloadedFile(downloadedFile)
200 if (err) logger.warn('Cannot destroy webtorrent in timeout.', { err })
207 function deleteDownloadedFile (downloadedFile: { directoryPath: string, filepath: string }) {
208 // We want to delete the base directory
209 let pathToDelete = dirname(downloadedFile.filepath)
210 if (pathToDelete === '.') pathToDelete = downloadedFile.filepath
212 const toRemovePath = join(downloadedFile.directoryPath, pathToDelete)
214 logger.debug('Removing %s after webtorrent download.', toRemovePath)
216 .catch(err => logger.error('Cannot remove torrent file %s in webtorrent download.', toRemovePath, { err }))
219 function buildAnnounceList () {
221 [ WEBSERVER.WS + '://' + WEBSERVER.HOSTNAME + ':' + WEBSERVER.PORT + '/tracker/socket' ],
222 [ WEBSERVER.URL + '/tracker/announce' ]
226 function buildUrlList (video: MVideo, videoFile: MVideoFile) {
227 return [ videoFile.getFileUrl(video) ]