]>
Commit | Line | Data |
---|---|---|
41fb13c3 C |
1 | import { decode, encode } from 'bencode' |
2 | import createTorrent from 'create-torrent' | |
1f6125be | 3 | import { createWriteStream, ensureDir, readFile, remove, writeFile } from 'fs-extra' |
41fb13c3 C |
4 | import magnetUtil from 'magnet-uri' |
5 | import parseTorrent from 'parse-torrent' | |
90a8bd30 | 6 | import { dirname, join } from 'path' |
41fb13c3 C |
7 | import { pipeline } from 'stream' |
8 | import WebTorrent, { Instance, TorrentFile } from 'webtorrent' | |
d7a25329 | 9 | import { isArray } from '@server/helpers/custom-validators/misc' |
90a8bd30 | 10 | import { WEBSERVER } from '@server/initializers/constants' |
0305db28 JB |
11 | import { generateTorrentFileName } from '@server/lib/paths' |
12 | import { VideoPathManager } from '@server/lib/video-path-manager' | |
8efc27bf | 13 | import { MVideo } from '@server/types/models/video/video' |
90a8bd30 C |
14 | import { MVideoFile, MVideoFileRedundanciesOpt } from '@server/types/models/video/video-file' |
15 | import { MStreamingPlaylistVideo } from '@server/types/models/video/video-streaming-playlist' | |
f304a158 | 16 | import { sha1 } from '@shared/extra-utils' |
90a8bd30 | 17 | import { CONFIG } from '../initializers/config' |
06aad801 | 18 | import { promisify2 } from './core-utils' |
90a8bd30 C |
19 | import { logger } from './logger' |
20 | import { generateVideoImportTmpPath } from './utils' | |
8efc27bf | 21 | import { extractVideo } from './video' |
d7a25329 C |
22 | |
23 | const createTorrentPromise = promisify2<string, any, any>(createTorrent) | |
ce33919c | 24 | |
02b286f8 C |
25 | async function downloadWebTorrentVideo (target: { uri: string, torrentName?: string }, timeout: number) { |
26 | const id = target.uri || target.torrentName | |
c48e82b5 | 27 | let timer |
ce33919c | 28 | |
6040f87d | 29 | const path = generateVideoImportTmpPath(id) |
990b6a0b | 30 | logger.info('Importing torrent video %s', id) |
ce33919c | 31 | |
6040f87d | 32 | const directoryPath = join(CONFIG.STORAGE.TMP_DIR, 'webtorrent') |
a71de50b C |
33 | await ensureDir(directoryPath) |
34 | ||
ce33919c C |
35 | return new Promise<string>((res, rej) => { |
36 | const webtorrent = new WebTorrent() | |
41fb13c3 | 37 | let file: TorrentFile |
ce33919c | 38 | |
02b286f8 | 39 | const torrentId = target.uri || join(CONFIG.STORAGE.TORRENTS_DIR, target.torrentName) |
541006e3 | 40 | |
a71de50b | 41 | const options = { path: directoryPath } |
541006e3 | 42 | const torrent = webtorrent.add(torrentId, options, torrent => { |
c48e82b5 C |
43 | if (torrent.files.length !== 1) { |
44 | if (timer) clearTimeout(timer) | |
ce33919c | 45 | |
a1587156 | 46 | for (const file of torrent.files) { |
e37c85e9 C |
47 | deleteDownloadedFile({ directoryPath, filepath: file.path }) |
48 | } | |
49 | ||
50 | return safeWebtorrentDestroy(webtorrent, torrentId, undefined, target.torrentName) | |
dae4a1c0 | 51 | .then(() => rej(new Error('Cannot import torrent ' + torrentId + ': there are multiple files in it'))) |
c48e82b5 C |
52 | } |
53 | ||
09509487 | 54 | logger.debug('Got torrent from webtorrent %s.', id, { infoHash: torrent.infoHash }) |
0bae6663 | 55 | |
a1587156 | 56 | file = torrent.files[0] |
a71de50b C |
57 | |
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) | |
62 | ||
a1587156 | 63 | safeWebtorrentDestroy(webtorrent, torrentId, { directoryPath, filepath: file.path }, target.torrentName) |
a71de50b | 64 | .then(() => res(path)) |
a1587156 | 65 | .catch(err => logger.error('Cannot destroy webtorrent.', { err })) |
69fa54a0 | 66 | }) |
a71de50b | 67 | |
0bae6663 C |
68 | pipeline( |
69 | file.createReadStream(), | |
70 | writeStream, | |
e111a5a3 C |
71 | err => { |
72 | if (err) rej(err) | |
73 | } | |
0bae6663 | 74 | ) |
3e17515e | 75 | }) |
ce33919c C |
76 | |
77 | torrent.on('error', err => rej(err)) | |
c48e82b5 | 78 | |
a1587156 C |
79 | timer = setTimeout(() => { |
80 | const err = new Error('Webtorrent download timeout.') | |
81 | ||
82 | safeWebtorrentDestroy(webtorrent, torrentId, file ? { directoryPath, filepath: file.path } : undefined, target.torrentName) | |
83 | .then(() => rej(err)) | |
84 | .catch(destroyErr => { | |
85 | logger.error('Cannot destroy webtorrent.', { err: destroyErr }) | |
86 | rej(err) | |
87 | }) | |
88 | ||
cf9166cf | 89 | }, timeout) |
ce33919c C |
90 | }) |
91 | } | |
92 | ||
1f6125be | 93 | function createTorrentAndSetInfoHash (videoOrPlaylist: MVideo | MStreamingPlaylistVideo, videoFile: MVideoFile) { |
c729caf6 C |
94 | return VideoPathManager.Instance.makeAvailableVideoFile(videoFile.withVideoOrPlaylist(videoOrPlaylist), videoPath => { |
95 | return createTorrentAndSetInfoHashFromPath(videoOrPlaylist, videoFile, videoPath) | |
96 | }) | |
97 | } | |
98 | ||
99 | async function createTorrentAndSetInfoHashFromPath ( | |
100 | videoOrPlaylist: MVideo | MStreamingPlaylistVideo, | |
101 | videoFile: MVideoFile, | |
102 | filePath: string | |
103 | ) { | |
8efc27bf C |
104 | const video = extractVideo(videoOrPlaylist) |
105 | ||
d7a25329 C |
106 | const options = { |
107 | // Keep the extname, it's used by the client to stream the file inside a web browser | |
9b293cd6 | 108 | name: buildInfoName(video, videoFile), |
d7a25329 | 109 | createdBy: 'PeerTube', |
1f6125be C |
110 | announceList: buildAnnounceList(), |
111 | urlList: buildUrlList(video, videoFile) | |
d7a25329 C |
112 | } |
113 | ||
c729caf6 | 114 | const torrentContent = await createTorrentPromise(filePath, options) |
d7a25329 | 115 | |
c729caf6 C |
116 | const torrentFilename = generateTorrentFileName(videoOrPlaylist, videoFile.resolution) |
117 | const torrentPath = join(CONFIG.STORAGE.TORRENTS_DIR, torrentFilename) | |
118 | logger.info('Creating torrent %s.', torrentPath) | |
d7a25329 | 119 | |
c729caf6 | 120 | await writeFile(torrentPath, torrentContent) |
d7a25329 | 121 | |
c729caf6 C |
122 | // Remove old torrent file if it existed |
123 | if (videoFile.hasTorrent()) { | |
124 | await remove(join(CONFIG.STORAGE.TORRENTS_DIR, videoFile.torrentFilename)) | |
125 | } | |
764b1a14 | 126 | |
c729caf6 C |
127 | const parsedTorrent = parseTorrent(torrentContent) |
128 | videoFile.infoHash = parsedTorrent.infoHash | |
129 | videoFile.torrentFilename = torrentFilename | |
d7a25329 C |
130 | } |
131 | ||
9b293cd6 | 132 | async function updateTorrentMetadata (videoOrPlaylist: MVideo | MStreamingPlaylistVideo, videoFile: MVideoFile) { |
1f6125be C |
133 | const video = extractVideo(videoOrPlaylist) |
134 | ||
135 | const oldTorrentPath = join(CONFIG.STORAGE.TORRENTS_DIR, videoFile.torrentFilename) | |
136 | ||
137 | const torrentContent = await readFile(oldTorrentPath) | |
41fb13c3 | 138 | const decoded = decode(torrentContent) |
1f6125be C |
139 | |
140 | decoded['announce-list'] = buildAnnounceList() | |
141 | decoded.announce = decoded['announce-list'][0][0] | |
142 | ||
143 | decoded['url-list'] = buildUrlList(video, videoFile) | |
144 | ||
9b293cd6 C |
145 | decoded.info.name = buildInfoName(video, videoFile) |
146 | decoded['creation date'] = Math.ceil(Date.now() / 1000) | |
147 | ||
1f6125be C |
148 | const newTorrentFilename = generateTorrentFileName(videoOrPlaylist, videoFile.resolution) |
149 | const newTorrentPath = join(CONFIG.STORAGE.TORRENTS_DIR, newTorrentFilename) | |
150 | ||
9b293cd6 | 151 | logger.info('Updating torrent metadata %s -> %s.', oldTorrentPath, newTorrentPath) |
1f6125be | 152 | |
41fb13c3 | 153 | await writeFile(newTorrentPath, encode(decoded)) |
f645af43 | 154 | await remove(join(CONFIG.STORAGE.TORRENTS_DIR, videoFile.torrentFilename)) |
1f6125be C |
155 | |
156 | videoFile.torrentFilename = newTorrentFilename | |
38d69d65 | 157 | videoFile.infoHash = sha1(encode(decoded.info)) |
1f6125be C |
158 | } |
159 | ||
d7a25329 | 160 | function generateMagnetUri ( |
8efc27bf | 161 | video: MVideo, |
d7a25329 | 162 | videoFile: MVideoFileRedundanciesOpt, |
d9a2a031 | 163 | trackerUrls: string[] |
d7a25329 | 164 | ) { |
90a8bd30 | 165 | const xs = videoFile.getTorrentUrl() |
d9a2a031 | 166 | const announce = trackerUrls |
90a8bd30 | 167 | let urlList = [ videoFile.getFileUrl(video) ] |
d7a25329 C |
168 | |
169 | const redundancies = videoFile.RedundancyVideos | |
170 | if (isArray(redundancies)) urlList = urlList.concat(redundancies.map(r => r.fileUrl)) | |
171 | ||
172 | const magnetHash = { | |
173 | xs, | |
174 | announce, | |
175 | urlList, | |
176 | infoHash: videoFile.infoHash, | |
177 | name: video.name | |
178 | } | |
179 | ||
180 | return magnetUtil.encode(magnetHash) | |
181 | } | |
30ff39e7 | 182 | |
ce33919c C |
183 | // --------------------------------------------------------------------------- |
184 | ||
185 | export { | |
d441f2ed | 186 | createTorrentPromise, |
9b293cd6 | 187 | updateTorrentMetadata, |
c729caf6 | 188 | |
d7a25329 | 189 | createTorrentAndSetInfoHash, |
c729caf6 C |
190 | createTorrentAndSetInfoHashFromPath, |
191 | ||
d7a25329 | 192 | generateMagnetUri, |
ce33919c C |
193 | downloadWebTorrentVideo |
194 | } | |
c48e82b5 C |
195 | |
196 | // --------------------------------------------------------------------------- | |
197 | ||
d0b52b52 | 198 | function safeWebtorrentDestroy ( |
41fb13c3 | 199 | webtorrent: Instance, |
d0b52b52 C |
200 | torrentId: string, |
201 | downloadedFile?: { directoryPath: string, filepath: string }, | |
202 | torrentName?: string | |
203 | ) { | |
ba5a8d89 | 204 | return new Promise<void>(res => { |
c48e82b5 C |
205 | webtorrent.destroy(err => { |
206 | // Delete torrent file | |
207 | if (torrentName) { | |
d0b52b52 | 208 | logger.debug('Removing %s torrent after webtorrent download.', torrentId) |
c48e82b5 C |
209 | remove(torrentId) |
210 | .catch(err => logger.error('Cannot remove torrent %s in webtorrent download.', torrentId, { err })) | |
211 | } | |
212 | ||
213 | // Delete downloaded file | |
e37c85e9 | 214 | if (downloadedFile) deleteDownloadedFile(downloadedFile) |
c48e82b5 | 215 | |
e37c85e9 | 216 | if (err) logger.warn('Cannot destroy webtorrent in timeout.', { err }) |
c48e82b5 C |
217 | |
218 | return res() | |
219 | }) | |
220 | }) | |
221 | } | |
e37c85e9 C |
222 | |
223 | function deleteDownloadedFile (downloadedFile: { directoryPath: string, filepath: string }) { | |
224 | // We want to delete the base directory | |
225 | let pathToDelete = dirname(downloadedFile.filepath) | |
226 | if (pathToDelete === '.') pathToDelete = downloadedFile.filepath | |
227 | ||
228 | const toRemovePath = join(downloadedFile.directoryPath, pathToDelete) | |
229 | ||
230 | logger.debug('Removing %s after webtorrent download.', toRemovePath) | |
231 | remove(toRemovePath) | |
232 | .catch(err => logger.error('Cannot remove torrent file %s in webtorrent download.', toRemovePath, { err })) | |
233 | } | |
1f6125be C |
234 | |
235 | function buildAnnounceList () { | |
236 | return [ | |
237 | [ WEBSERVER.WS + '://' + WEBSERVER.HOSTNAME + ':' + WEBSERVER.PORT + '/tracker/socket' ], | |
238 | [ WEBSERVER.URL + '/tracker/announce' ] | |
239 | ] | |
240 | } | |
241 | ||
242 | function buildUrlList (video: MVideo, videoFile: MVideoFile) { | |
243 | return [ videoFile.getFileUrl(video) ] | |
244 | } | |
9b293cd6 C |
245 | |
246 | function buildInfoName (video: MVideo, videoFile: MVideoFile) { | |
247 | return `${video.name} ${videoFile.resolution}p${videoFile.extname}` | |
248 | } |