forked from webtorrent/webtorrent
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
437 lines (366 loc) · 12.2 KB
/
index.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
/* global FileList */
const { EventEmitter } = require('events')
const concat = require('simple-concat')
const createTorrent = require('create-torrent')
const debug = require('debug')('webtorrent')
const DHT = require('bittorrent-dht/client') // browser exclude
const loadIPSet = require('load-ip-set') // browser exclude
const parallel = require('run-parallel')
const parseTorrent = require('parse-torrent')
const path = require('path')
const Peer = require('simple-peer')
const randombytes = require('randombytes')
const speedometer = require('speedometer')
const TCPPool = require('./lib/tcp-pool') // browser exclude
const Torrent = require('./lib/torrent')
const VERSION = require('./package.json').version
/**
* Version number in Azureus-style. Generated from major and minor semver version.
* For example:
* '0.16.1' -> '0016'
* '1.2.5' -> '0102'
*/
const VERSION_STR = VERSION
.replace(/\d*./g, v => `0${v % 100}`.slice(-2))
.slice(0, 4)
/**
* Version prefix string (used in peer ID). WebTorrent uses the Azureus-style
* encoding: '-', two characters for client id ('WW'), four ascii digits for version
* number, '-', followed by random numbers.
* For example:
* '-WW0102-'...
*/
const VERSION_PREFIX = `-WW${VERSION_STR}-`
/**
* WebTorrent Client
* @param {Object=} opts
*/
class WebTorrent extends EventEmitter {
constructor (opts = {}) {
super()
if (typeof opts.peerId === 'string') {
this.peerId = opts.peerId
} else if (Buffer.isBuffer(opts.peerId)) {
this.peerId = opts.peerId.toString('hex')
} else {
this.peerId = Buffer.from(VERSION_PREFIX + randombytes(9).toString('base64')).toString('hex')
}
this.peerIdBuffer = Buffer.from(this.peerId, 'hex')
if (typeof opts.nodeId === 'string') {
this.nodeId = opts.nodeId
} else if (Buffer.isBuffer(opts.nodeId)) {
this.nodeId = opts.nodeId.toString('hex')
} else {
this.nodeId = randombytes(20).toString('hex')
}
this.nodeIdBuffer = Buffer.from(this.nodeId, 'hex')
this._debugId = this.peerId.toString('hex').substring(0, 7)
this.destroyed = false
this.listening = false
this.torrentPort = opts.torrentPort || 0
this.dhtPort = opts.dhtPort || 0
this.tracker = opts.tracker !== undefined ? opts.tracker : {}
this.torrents = []
this.maxConns = Number(opts.maxConns) || 55
this._debug(
'new webtorrent (peerId %s, nodeId %s, port %s)',
this.peerId, this.nodeId, this.torrentPort
)
if (this.tracker) {
if (typeof this.tracker !== 'object') this.tracker = {}
if (opts.rtcConfig) {
// TODO: remove in v1
console.warn('WebTorrent: opts.rtcConfig is deprecated. Use opts.tracker.rtcConfig instead')
this.tracker.rtcConfig = opts.rtcConfig
}
if (opts.wrtc) {
// TODO: remove in v1
console.warn('WebTorrent: opts.wrtc is deprecated. Use opts.tracker.wrtc instead')
this.tracker.wrtc = opts.wrtc
}
if (global.WRTC && !this.tracker.wrtc) {
this.tracker.wrtc = global.WRTC
}
}
if (typeof TCPPool === 'function') {
this._tcpPool = new TCPPool(this)
} else {
process.nextTick(() => {
this._onListening()
})
}
// stats
this._downloadSpeed = speedometer()
this._uploadSpeed = speedometer()
if (opts.dht !== false && typeof DHT === 'function' /* browser exclude */) {
// use a single DHT instance for all torrents, so the routing table can be reused
this.dht = new DHT(Object.assign({}, { nodeId: this.nodeId }, opts.dht))
this.dht.once('error', err => {
this._destroy(err)
})
this.dht.once('listening', () => {
const address = this.dht.address()
if (address) this.dhtPort = address.port
})
// Ignore warning when there are > 10 torrents in the client
this.dht.setMaxListeners(0)
this.dht.listen(this.dhtPort)
} else {
this.dht = false
}
// Enable or disable BEP19 (Web Seeds). Enabled by default:
this.enableWebSeeds = opts.webSeeds !== false
const ready = () => {
if (this.destroyed) return
this.ready = true
this.emit('ready')
}
if (typeof loadIPSet === 'function' && opts.blocklist != null) {
loadIPSet(opts.blocklist, {
headers: {
'user-agent': `WebTorrent/${VERSION} (https://webtorrent.io)`
}
}, (err, ipSet) => {
if (err) return this.error(`Failed to load blocklist: ${err.message}`)
this.blocked = ipSet
ready()
})
} else {
process.nextTick(ready)
}
}
get downloadSpeed () { return this._downloadSpeed() }
get uploadSpeed () { return this._uploadSpeed() }
get progress () {
const torrents = this.torrents.filter(torrent => torrent.progress !== 1)
const downloaded = torrents.reduce((total, torrent) => total + torrent.downloaded, 0)
const length = torrents.reduce((total, torrent) => total + (torrent.length || 0), 0) || 1
return downloaded / length
}
get ratio () {
const uploaded = this.torrents.reduce((total, torrent) => total + torrent.uploaded, 0)
const received = this.torrents.reduce((total, torrent) => total + torrent.received, 0) || 1
return uploaded / received
}
/**
* Returns the torrent with the given `torrentId`. Convenience method. Easier than
* searching through the `client.torrents` array. Returns `null` if no matching torrent
* found.
*
* @param {string|Buffer|Object|Torrent} torrentId
* @return {Torrent|null}
*/
get (torrentId) {
if (torrentId instanceof Torrent) {
if (this.torrents.includes(torrentId)) return torrentId
} else {
let parsed
try { parsed = parseTorrent(torrentId) } catch (err) {}
if (!parsed) return null
if (!parsed.infoHash) throw new Error('Invalid torrent identifier')
for (const torrent of this.torrents) {
if (torrent.infoHash === parsed.infoHash) return torrent
}
}
return null
}
// TODO: remove in v1
download (torrentId, opts, ontorrent) {
console.warn('WebTorrent: client.download() is deprecated. Use client.add() instead')
return this.add(torrentId, opts, ontorrent)
}
/**
* Start downloading a new torrent. Aliased as `client.download`.
* @param {string|Buffer|Object} torrentId
* @param {Object} opts torrent-specific options
* @param {function=} ontorrent called when the torrent is ready (has metadata)
*/
add (torrentId, opts = {}, ontorrent) {
if (this.destroyed) throw new Error('client is destroyed')
if (typeof opts === 'function') [opts, ontorrent] = [{}, opts]
const onInfoHash = () => {
if (this.destroyed) return
for (const t of this.torrents) {
if (t.infoHash === torrent.infoHash && t !== torrent) {
torrent._destroy(new Error(`Cannot add duplicate torrent ${torrent.infoHash}`))
return
}
}
}
const onReady = () => {
if (this.destroyed) return
if (typeof ontorrent === 'function') ontorrent(torrent)
this.emit('torrent', torrent)
}
function onClose () {
torrent.removeListener('_infoHash', onInfoHash)
torrent.removeListener('ready', onReady)
torrent.removeListener('close', onClose)
}
this._debug('add')
opts = opts ? Object.assign({}, opts) : {}
const torrent = new Torrent(torrentId, this, opts)
this.torrents.push(torrent)
torrent.once('_infoHash', onInfoHash)
torrent.once('ready', onReady)
torrent.once('close', onClose)
return torrent
}
/**
* Start seeding a new file/folder.
* @param {string|File|FileList|Buffer|Array.<string|File|Buffer>} input
* @param {Object=} opts
* @param {function=} onseed called when torrent is seeding
*/
seed (input, opts, onseed) {
if (this.destroyed) throw new Error('client is destroyed')
if (typeof opts === 'function') [opts, onseed] = [{}, opts]
this._debug('seed')
opts = opts ? Object.assign({}, opts) : {}
// no need to verify the hashes we create
opts.skipVerify = true
const isFilePath = typeof input === 'string'
// When seeding from fs path, initialize store from that path to avoid a copy
if (isFilePath) opts.path = path.dirname(input)
if (!opts.createdBy) opts.createdBy = `WebTorrent/${VERSION_STR}`
const onTorrent = torrent => {
const tasks = [
cb => {
// when a filesystem path is specified, files are already in the FS store
if (isFilePath) return cb()
torrent.load(streams, cb)
}
]
if (this.dht) {
tasks.push(cb => {
torrent.once('dhtAnnounce', cb)
})
}
parallel(tasks, err => {
if (this.destroyed) return
if (err) return torrent._destroy(err)
_onseed(torrent)
})
}
const _onseed = torrent => {
this._debug('on seed')
if (typeof onseed === 'function') onseed(torrent)
torrent.emit('seed')
this.emit('seed', torrent)
}
const torrent = this.add(null, opts, onTorrent)
let streams
if (isFileList(input)) input = Array.from(input)
else if (!Array.isArray(input)) input = [input]
parallel(input.map(item => cb => {
if (isReadable(item)) concat(item, cb)
else cb(null, item)
}), (err, input) => {
if (this.destroyed) return
if (err) return torrent._destroy(err)
createTorrent.parseInput(input, opts, (err, files) => {
if (this.destroyed) return
if (err) return torrent._destroy(err)
streams = files.map(file => file.getStream)
createTorrent(input, opts, (err, torrentBuf) => {
if (this.destroyed) return
if (err) return torrent._destroy(err)
const existingTorrent = this.get(torrentBuf)
if (existingTorrent) {
torrent._destroy(new Error(`Cannot add duplicate torrent ${existingTorrent.infoHash}`))
} else {
torrent._onTorrentId(torrentBuf)
}
})
})
})
return torrent
}
/**
* Remove a torrent from the client.
* @param {string|Buffer|Torrent} torrentId
* @param {function} cb
*/
remove (torrentId, cb) {
this._debug('remove')
const torrent = this.get(torrentId)
if (!torrent) throw new Error(`No torrent with id ${torrentId}`)
this._remove(torrentId, cb)
}
_remove (torrentId, cb) {
const torrent = this.get(torrentId)
if (!torrent) return
this.torrents.splice(this.torrents.indexOf(torrent), 1)
torrent.destroy(cb)
}
address () {
if (!this.listening) return null
return this._tcpPool
? this._tcpPool.server.address()
: { address: '0.0.0.0', family: 'IPv4', port: 0 }
}
/**
* Destroy the client, including all torrents and connections to peers.
* @param {function} cb
*/
destroy (cb) {
if (this.destroyed) throw new Error('client already destroyed')
this._destroy(null, cb)
}
_destroy (err, cb) {
this._debug('client destroy')
this.destroyed = true
const tasks = this.torrents.map(torrent => cb => {
torrent.destroy(cb)
})
if (this._tcpPool) {
tasks.push(cb => {
this._tcpPool.destroy(cb)
})
}
if (this.dht) {
tasks.push(cb => {
this.dht.destroy(cb)
})
}
parallel(tasks, cb)
if (err) this.emit('error', err)
this.torrents = []
this._tcpPool = null
this.dht = null
}
_onListening () {
this._debug('listening')
this.listening = true
if (this._tcpPool) {
// Sometimes server.address() returns `null` in Docker.
const address = this._tcpPool.server.address()
if (address) this.torrentPort = address.port
}
this.emit('listening')
}
_debug () {
const args = [].slice.call(arguments)
args[0] = `[${this._debugId}] ${args[0]}`
debug(...args)
}
}
WebTorrent.WEBRTC_SUPPORT = Peer.WEBRTC_SUPPORT
WebTorrent.VERSION = VERSION
/**
* Check if `obj` is a node Readable stream
* @param {*} obj
* @return {boolean}
*/
function isReadable (obj) {
return typeof obj === 'object' && obj != null && typeof obj.pipe === 'function'
}
/**
* Check if `obj` is a W3C `FileList` object
* @param {*} obj
* @return {boolean}
*/
function isFileList (obj) {
return typeof FileList !== 'undefined' && obj instanceof FileList
}
module.exports = WebTorrent