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 { sha1 } from '@shared/extra-utils'
17 import { CONFIG } from '../initializers/config'
18 import { promisify2 } from './core-utils'
19 import { logger } from './logger'
20 import { generateVideoImportTmpPath } from './utils'
21 import { extractVideo } from './video'
23 const createTorrentPromise = promisify2<string, any, any>(createTorrent)
25 async function downloadWebTorrentVideo (target: { uri: string, torrentName?: string }, timeout: number) {
26 const id = target.uri || target.torrentName
29 const path = generateVideoImportTmpPath(id)
30 logger.info('Importing torrent video %s', id)
32 const directoryPath = join(CONFIG.STORAGE.TMP_DIR, 'webtorrent')
33 await ensureDir(directoryPath)
35 return new Promise<string>((res, rej) => {
36 const webtorrent = new WebTorrent()
39 const torrentId = target.uri || join(CONFIG.STORAGE.TORRENTS_DIR, target.torrentName)
41 const options = { path: directoryPath }
42 const torrent = webtorrent.add(torrentId, options, torrent => {
43 if (torrent.files.length !== 1) {
44 if (timer) clearTimeout(timer)
46 for (const file of torrent.files) {
47 deleteDownloadedFile({ directoryPath, filepath: file.path })
50 return safeWebtorrentDestroy(webtorrent, torrentId, undefined, target.torrentName)
51 .then(() => rej(new Error('Cannot import torrent ' + torrentId + ': there are multiple files in it')))
54 logger.debug('Got torrent from webtorrent %s.', id, { infoHash: torrent.infoHash })
56 file = torrent.files[0]
58 // FIXME: avoid creating another stream when https://github.com/webtorrent/webtorrent/issues/1517 is fixed
59 const writeStream = createWriteStream(path)
60 writeStream.on('finish', () => {
61 if (timer) clearTimeout(timer)
63 safeWebtorrentDestroy(webtorrent, torrentId, { directoryPath, filepath: file.path }, target.torrentName)
64 .then(() => res(path))
65 .catch(err => logger.error('Cannot destroy webtorrent.', { err }))
69 file.createReadStream(),
77 torrent.on('error', err => rej(err))
79 timer = setTimeout(() => {
80 const err = new Error('Webtorrent download timeout.')
82 safeWebtorrentDestroy(webtorrent, torrentId, file ? { directoryPath, filepath: file.path } : undefined, target.torrentName)
84 .catch(destroyErr => {
85 logger.error('Cannot destroy webtorrent.', { err: destroyErr })
93 function createTorrentAndSetInfoHash (videoOrPlaylist: MVideo | MStreamingPlaylistVideo, videoFile: MVideoFile) {
94 const video = extractVideo(videoOrPlaylist)
97 // Keep the extname, it's used by the client to stream the file inside a web browser
98 name: buildInfoName(video, videoFile),
99 createdBy: 'PeerTube',
100 announceList: buildAnnounceList(),
101 urlList: buildUrlList(video, videoFile)
104 return VideoPathManager.Instance.makeAvailableVideoFile(videoFile.withVideoOrPlaylist(videoOrPlaylist), async videoPath => {
105 const torrentContent = await createTorrentPromise(videoPath, options)
107 const torrentFilename = generateTorrentFileName(videoOrPlaylist, videoFile.resolution)
108 const torrentPath = join(CONFIG.STORAGE.TORRENTS_DIR, torrentFilename)
109 logger.info('Creating torrent %s.', torrentPath)
111 await writeFile(torrentPath, torrentContent)
113 // Remove old torrent file if it existed
114 if (videoFile.hasTorrent()) {
115 await remove(join(CONFIG.STORAGE.TORRENTS_DIR, videoFile.torrentFilename))
118 const parsedTorrent = parseTorrent(torrentContent)
119 videoFile.infoHash = parsedTorrent.infoHash
120 videoFile.torrentFilename = torrentFilename
124 async function updateTorrentMetadata (videoOrPlaylist: MVideo | MStreamingPlaylistVideo, videoFile: MVideoFile) {
125 const video = extractVideo(videoOrPlaylist)
127 const oldTorrentPath = join(CONFIG.STORAGE.TORRENTS_DIR, videoFile.torrentFilename)
129 const torrentContent = await readFile(oldTorrentPath)
130 const decoded = decode(torrentContent)
132 decoded['announce-list'] = buildAnnounceList()
133 decoded.announce = decoded['announce-list'][0][0]
135 decoded['url-list'] = buildUrlList(video, videoFile)
137 decoded.info.name = buildInfoName(video, videoFile)
138 decoded['creation date'] = Math.ceil(Date.now() / 1000)
140 const newTorrentFilename = generateTorrentFileName(videoOrPlaylist, videoFile.resolution)
141 const newTorrentPath = join(CONFIG.STORAGE.TORRENTS_DIR, newTorrentFilename)
143 logger.info('Updating torrent metadata %s -> %s.', oldTorrentPath, newTorrentPath)
145 await writeFile(newTorrentPath, encode(decoded))
146 await remove(join(CONFIG.STORAGE.TORRENTS_DIR, videoFile.torrentFilename))
148 videoFile.torrentFilename = newTorrentFilename
149 videoFile.infoHash = sha1(encode(decoded.info))
152 function generateMagnetUri (
154 videoFile: MVideoFileRedundanciesOpt,
155 trackerUrls: string[]
157 const xs = videoFile.getTorrentUrl()
158 const announce = trackerUrls
159 let urlList = [ videoFile.getFileUrl(video) ]
161 const redundancies = videoFile.RedundancyVideos
162 if (isArray(redundancies)) urlList = urlList.concat(redundancies.map(r => r.fileUrl))
168 infoHash: videoFile.infoHash,
172 return magnetUtil.encode(magnetHash)
175 // ---------------------------------------------------------------------------
178 createTorrentPromise,
179 updateTorrentMetadata,
180 createTorrentAndSetInfoHash,
182 downloadWebTorrentVideo
185 // ---------------------------------------------------------------------------
187 function safeWebtorrentDestroy (
188 webtorrent: Instance,
190 downloadedFile?: { directoryPath: string, filepath: string },
193 return new Promise<void>(res => {
194 webtorrent.destroy(err => {
195 // Delete torrent file
197 logger.debug('Removing %s torrent after webtorrent download.', torrentId)
199 .catch(err => logger.error('Cannot remove torrent %s in webtorrent download.', torrentId, { err }))
202 // Delete downloaded file
203 if (downloadedFile) deleteDownloadedFile(downloadedFile)
205 if (err) logger.warn('Cannot destroy webtorrent in timeout.', { err })
212 function deleteDownloadedFile (downloadedFile: { directoryPath: string, filepath: string }) {
213 // We want to delete the base directory
214 let pathToDelete = dirname(downloadedFile.filepath)
215 if (pathToDelete === '.') pathToDelete = downloadedFile.filepath
217 const toRemovePath = join(downloadedFile.directoryPath, pathToDelete)
219 logger.debug('Removing %s after webtorrent download.', toRemovePath)
221 .catch(err => logger.error('Cannot remove torrent file %s in webtorrent download.', toRemovePath, { err }))
224 function buildAnnounceList () {
226 [ WEBSERVER.WS + '://' + WEBSERVER.HOSTNAME + ':' + WEBSERVER.PORT + '/tracker/socket' ],
227 [ WEBSERVER.URL + '/tracker/announce' ]
231 function buildUrlList (video: MVideo, videoFile: MVideoFile) {
232 return [ videoFile.getFileUrl(video) ]
235 function buildInfoName (video: MVideo, videoFile: MVideoFile) {
236 return `${video.name} ${videoFile.resolution}p${videoFile.extname}`