server/helpers/webtorrent.ts

   1 import * as createTorrent from 'create-torrent'
   2 import { createWriteStream, ensureDir, remove, writeFile } from 'fs-extra'
   3 import * as magnetUtil from 'magnet-uri'
   4 import * as parseTorrent from 'parse-torrent'
   5 import { dirname, join } from 'path'
   6 import * as WebTorrent from 'webtorrent'
   7 import { isArray } from '@server/helpers/custom-validators/misc'
   8 import { WEBSERVER } from '@server/initializers/constants'
   9 import { generateTorrentFileName, getVideoFilePath } from '@server/lib/video-paths'
  10 import { MVideo, MVideoWithHost } from '@server/types/models/video/video'
  11 import { MVideoFile, MVideoFileRedundanciesOpt } from '@server/types/models/video/video-file'
  12 import { MStreamingPlaylistVideo } from '@server/types/models/video/video-streaming-playlist'
  13 import { CONFIG } from '../initializers/config'
  14 import { promisify2 } from './core-utils'
  15 import { logger } from './logger'
  16 import { generateVideoImportTmpPath } from './utils'
  17
  18 const createTorrentPromise = promisify2<string, any, any>(createTorrent)
  19
  20 async function downloadWebTorrentVideo (target: { magnetUri: string, torrentName?: string }, timeout: number) {
  21   const id = target.magnetUri || target.torrentName
  22   let timer
  23
  24   const path = generateVideoImportTmpPath(id)
  25   logger.info('Importing torrent video %s', id)
  26
  27   const directoryPath = join(CONFIG.STORAGE.TMP_DIR, 'webtorrent')
  28   await ensureDir(directoryPath)
  29
  30   return new Promise<string>((res, rej) => {
  31     const webtorrent = new WebTorrent()
  32     let file: WebTorrent.TorrentFile
  33
  34     const torrentId = target.magnetUri || join(CONFIG.STORAGE.TORRENTS_DIR, target.torrentName)
  35
  36     const options = { path: directoryPath }
  37     const torrent = webtorrent.add(torrentId, options, torrent => {
  38       if (torrent.files.length !== 1) {
  39         if (timer) clearTimeout(timer)
  40
  41         for (const file of torrent.files) {
  42           deleteDownloadedFile({ directoryPath, filepath: file.path })
  43         }
  44
  45         return safeWebtorrentDestroy(webtorrent, torrentId, undefined, target.torrentName)
  46           .then(() => rej(new Error('Cannot import torrent ' + torrentId + ': there are multiple files in it')))
  47       }
  48
  49       file = torrent.files[0]
  50
  51       // FIXME: avoid creating another stream when https://github.com/webtorrent/webtorrent/issues/1517 is fixed
  52       const writeStream = createWriteStream(path)
  53       writeStream.on('finish', () => {
  54         if (timer) clearTimeout(timer)
  55
  56         safeWebtorrentDestroy(webtorrent, torrentId, { directoryPath, filepath: file.path }, target.torrentName)
  57           .then(() => res(path))
  58           .catch(err => logger.error('Cannot destroy webtorrent.', { err }))
  59       })
  60
  61       file.createReadStream().pipe(writeStream)
  62     })
  63
  64     torrent.on('error', err => rej(err))
  65
  66     timer = setTimeout(() => {
  67       const err = new Error('Webtorrent download timeout.')
  68
  69       safeWebtorrentDestroy(webtorrent, torrentId, file ? { directoryPath, filepath: file.path } : undefined, target.torrentName)
  70         .then(() => rej(err))
  71         .catch(destroyErr => {
  72           logger.error('Cannot destroy webtorrent.', { err: destroyErr })
  73           rej(err)
  74         })
  75
  76     }, timeout)
  77   })
  78 }
  79
  80 // FIXME: refactor/merge videoOrPlaylist and video arguments
  81 async function createTorrentAndSetInfoHash (
  82   videoOrPlaylist: MVideo | MStreamingPlaylistVideo,
  83   video: MVideoWithHost,
  84   videoFile: MVideoFile
  85 ) {
  86   const options = {
  87     // Keep the extname, it's used by the client to stream the file inside a web browser
  88     name: `${video.name} ${videoFile.resolution}p${videoFile.extname}`,
  89     createdBy: 'PeerTube',
  90     announceList: [
  91       [ WEBSERVER.WS + '://' + WEBSERVER.HOSTNAME + ':' + WEBSERVER.PORT + '/tracker/socket' ],
  92       [ WEBSERVER.URL + '/tracker/announce' ]
  93     ],
  94     urlList: [ videoFile.getFileUrl(video) ]
  95   }
  96
  97   const torrent = await createTorrentPromise(getVideoFilePath(videoOrPlaylist, videoFile), options)
  98
  99   const torrentFilename = generateTorrentFileName(videoOrPlaylist, videoFile.resolution)
 100   const torrentPath = join(CONFIG.STORAGE.TORRENTS_DIR, torrentFilename)
 101   logger.info('Creating torrent %s.', torrentPath)
 102
 103   await writeFile(torrentPath, torrent)
 104
 105   const parsedTorrent = parseTorrent(torrent)
 106   videoFile.infoHash = parsedTorrent.infoHash
 107   videoFile.torrentFilename = torrentFilename
 108 }
 109
 110 function generateMagnetUri (
 111   video: MVideoWithHost,
 112   videoFile: MVideoFileRedundanciesOpt,
 113   trackerUrls: string[]
 114 ) {
 115   const xs = videoFile.getTorrentUrl()
 116   const announce = trackerUrls
 117   let urlList = [ videoFile.getFileUrl(video) ]
 118
 119   const redundancies = videoFile.RedundancyVideos
 120   if (isArray(redundancies)) urlList = urlList.concat(redundancies.map(r => r.fileUrl))
 121
 122   const magnetHash = {
 123     xs,
 124     announce,
 125     urlList,
 126     infoHash: videoFile.infoHash,
 127     name: video.name
 128   }
 129
 130   return magnetUtil.encode(magnetHash)
 131 }
 132
 133 // ---------------------------------------------------------------------------
 134
 135 export {
 136   createTorrentPromise,
 137   createTorrentAndSetInfoHash,
 138   generateMagnetUri,
 139   downloadWebTorrentVideo
 140 }
 141
 142 // ---------------------------------------------------------------------------
 143
 144 function safeWebtorrentDestroy (
 145   webtorrent: WebTorrent.Instance,
 146   torrentId: string,
 147   downloadedFile?: { directoryPath: string, filepath: string },
 148   torrentName?: string
 149 ) {
 150   return new Promise<void>(res => {
 151     webtorrent.destroy(err => {
 152       // Delete torrent file
 153       if (torrentName) {
 154         logger.debug('Removing %s torrent after webtorrent download.', torrentId)
 155         remove(torrentId)
 156           .catch(err => logger.error('Cannot remove torrent %s in webtorrent download.', torrentId, { err }))
 157       }
 158
 159       // Delete downloaded file
 160       if (downloadedFile) deleteDownloadedFile(downloadedFile)
 161
 162       if (err) logger.warn('Cannot destroy webtorrent in timeout.', { err })
 163
 164       return res()
 165     })
 166   })
 167 }
 168
 169 function deleteDownloadedFile (downloadedFile: { directoryPath: string, filepath: string }) {
 170   // We want to delete the base directory
 171   let pathToDelete = dirname(downloadedFile.filepath)
 172   if (pathToDelete === '.') pathToDelete = downloadedFile.filepath
 173
 174   const toRemovePath = join(downloadedFile.directoryPath, pathToDelete)
 175
 176   logger.debug('Removing %s after webtorrent download.', toRemovePath)
 177   remove(toRemovePath)
 178     .catch(err => logger.error('Cannot remove torrent file %s in webtorrent download.', toRemovePath, { err }))
 179 }