Delete each file on failed import
[oweals/peertube.git] / server / helpers / webtorrent.ts
1 import { logger } from './logger'
2 import { generateVideoTmpPath } from './utils'
3 import * as WebTorrent from 'webtorrent'
4 import { createWriteStream, ensureDir, remove } from 'fs-extra'
5 import { CONFIG } from '../initializers'
6 import { dirname, join } from 'path'
7
8 async function downloadWebTorrentVideo (target: { magnetUri: string, torrentName?: string }, timeout?: number) {
9   const id = target.magnetUri || target.torrentName
10   let timer
11
12   const path = generateVideoTmpPath(id)
13   logger.info('Importing torrent video %s', id)
14
15   const directoryPath = join(CONFIG.STORAGE.VIDEOS_DIR, 'import')
16   await ensureDir(directoryPath)
17
18   return new Promise<string>((res, rej) => {
19     const webtorrent = new WebTorrent()
20     let file: WebTorrent.TorrentFile
21
22     const torrentId = target.magnetUri || join(CONFIG.STORAGE.TORRENTS_DIR, target.torrentName)
23
24     const options = { path: directoryPath }
25     const torrent = webtorrent.add(torrentId, options, torrent => {
26       if (torrent.files.length !== 1) {
27         if (timer) clearTimeout(timer)
28
29         for (let file of torrent.files) {
30           deleteDownloadedFile({ directoryPath, filepath: file.path })
31         }
32
33         return safeWebtorrentDestroy(webtorrent, torrentId, undefined, target.torrentName)
34           .then(() => rej(new Error('Cannot import torrent ' + torrentId + ': there are multiple files in it')))
35       }
36
37       file = torrent.files[ 0 ]
38
39       // FIXME: avoid creating another stream when https://github.com/webtorrent/webtorrent/issues/1517 is fixed
40       const writeStream = createWriteStream(path)
41       writeStream.on('finish', () => {
42         if (timer) clearTimeout(timer)
43
44         return safeWebtorrentDestroy(webtorrent, torrentId, { directoryPath, filepath: file.path }, target.torrentName)
45           .then(() => res(path))
46       })
47
48       file.createReadStream().pipe(writeStream)
49     })
50
51     torrent.on('error', err => rej(err))
52
53     if (timeout) {
54       timer = setTimeout(async () => {
55         return safeWebtorrentDestroy(webtorrent, torrentId, file ? { directoryPath, filepath: file.path } : undefined, target.torrentName)
56           .then(() => rej(new Error('Webtorrent download timeout.')))
57       }, timeout)
58     }
59   })
60 }
61
62 // ---------------------------------------------------------------------------
63
64 export {
65   downloadWebTorrentVideo
66 }
67
68 // ---------------------------------------------------------------------------
69
70 function safeWebtorrentDestroy (
71   webtorrent: WebTorrent.Instance,
72   torrentId: string,
73   downloadedFile?: { directoryPath: string, filepath: string },
74   torrentName?: string
75 ) {
76   return new Promise(res => {
77     webtorrent.destroy(err => {
78       // Delete torrent file
79       if (torrentName) {
80         logger.debug('Removing %s torrent after webtorrent download.', torrentId)
81         remove(torrentId)
82           .catch(err => logger.error('Cannot remove torrent %s in webtorrent download.', torrentId, { err }))
83       }
84
85       // Delete downloaded file
86       if (downloadedFile) deleteDownloadedFile(downloadedFile)
87
88       if (err) logger.warn('Cannot destroy webtorrent in timeout.', { err })
89
90       return res()
91     })
92   })
93 }
94
95 function deleteDownloadedFile (downloadedFile: { directoryPath: string, filepath: string }) {
96   // We want to delete the base directory
97   let pathToDelete = dirname(downloadedFile.filepath)
98   if (pathToDelete === '.') pathToDelete = downloadedFile.filepath
99
100   const toRemovePath = join(downloadedFile.directoryPath, pathToDelete)
101
102   logger.debug('Removing %s after webtorrent download.', toRemovePath)
103   remove(toRemovePath)
104     .catch(err => logger.error('Cannot remove torrent file %s in webtorrent download.', toRemovePath, { err }))
105 }