server/helpers/webtorrent.ts

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