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