Merge remote-tracking branch 'upstream/master' into proxy

Author: alxhotel

.npmignore

@@ -1 +1,6 @@
-img.png
+.travis.yml
+CONTRIBUTING.md
+examples/
+img/
+test/
+tools/

.travis.yml

@@ -1,6 +1,10 @@
 language: node_js
 sudo: false
 node_js:
-  - "node"
+  - lts/*
 before_script:
-  - export DISPLAY=:99.0; sh -e /etc/init.d/xvfb start
+  # Add an IPv6 config - see the corresponding Travis issue
+  # https://github.com/travis-ci/travis-ci/issues/8361
+  - if [ "${TRAVIS_OS_NAME}" == "linux" ]; then
+      sudo sh -c 'echo 0 > /proc/sys/net/ipv6/conf/all/disable_ipv6';
+    fi

AUTHORS.md

@@ -24,12 +24,31 @@
 - Alex ([email protected])
 - Harsh Vakharia ([email protected])
 - Yoann Ciabaud ([email protected])
-- Diego Rodríguez Baquero ([email protected])
 - Autarc ([email protected])
+- Diego Rodríguez Baquero ([email protected])
 - Kirill Fomichev ([email protected])
 - Matt Bell ([email protected])
+- Diego Rodríguez ([email protected])
 - Philipp Henkel ([email protected])
 - jakefb ([email protected])
 - Nick Frost ([email protected])
+- ZunSThy ([email protected])
+- vijayanand nandam ([email protected])
+- Luigi Pinca ([email protected])
+- Diego R. B ([email protected])
+- greenkeeper[bot] (greenkeeper[bot]@users.noreply.github.com)
+- hrafnkell orri sigurdsson ([email protected])
+- Brian Clifton ([email protected])
+- James M Snell ([email protected])
+- crapthings ([email protected])
+- daiyu ([email protected])
+- LI ([email protected])
+- Jimmy Wärting ([email protected])
+- Justin Kalland ([email protected])
+- greenkeeper[bot] (23040076+greenkeeper[bot]@users.noreply.github.com)
+- Eric Guan ([email protected])
+- Koushik Dutta ([email protected])
+- KayleePop ([email protected])
+- Diego Rodriguez Baquero ([email protected])
 
-#### Generated by bin/update-authors.sh.
+#### Generated by tools/update-authors.sh.

CONTRIBUTING.md

@@ -24,7 +24,7 @@ and to avoid style arguments. `npm test` runs `standard` automatically, so you d
 to!
 
 [standard-image]: https://cdn.rawgit.com/feross/standard/master/badge.svg
-[standard-url]: https://github.com/feross/standard
+[standard-url]: https://standardjs.com
 
 ## Project Governance
 

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) Feross Aboukhadijeh
+Copyright (c) Feross Aboukhadijeh and WebTorrent, LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

README.md

@@ -1,15 +1,17 @@
-# bittorrent-tracker [![travis][travis-image]][travis-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url]
+# bittorrent-tracker [![travis][travis-image]][travis-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url] [![javascript style guide][standard-image]][standard-url]
 
-[travis-image]: https://img.shields.io/travis/feross/bittorrent-tracker/master.svg
-[travis-url]: https://travis-ci.org/feross/bittorrent-tracker
+[travis-image]: https://img.shields.io/travis/webtorrent/bittorrent-tracker/master.svg
+[travis-url]: https://travis-ci.org/webtorrent/bittorrent-tracker
 [npm-image]: https://img.shields.io/npm/v/bittorrent-tracker.svg
 [npm-url]: https://npmjs.org/package/bittorrent-tracker
 [downloads-image]: https://img.shields.io/npm/dm/bittorrent-tracker.svg
 [downloads-url]: https://npmjs.org/package/bittorrent-tracker
+[standard-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg
+[standard-url]: https://standardjs.com
 
 #### Simple, robust, BitTorrent tracker (client & server) implementation
 
-![tracker](https://raw.githubusercontent.com/feross/bittorrent-tracker/master/img.png)
+![tracker visualization](img/img.png)
 
 Node.js implementation of a [BitTorrent tracker](https://wiki.theory.org/BitTorrentSpecification#Tracker_HTTP.2FHTTPS_Protocol), client and server.
 
@@ -31,10 +33,14 @@ This module is used by [WebTorrent](http://webtorrent.io).
 - Supports tracker "scrape" extension
 - Robust and well-tested
   - Comprehensive test suite (runs entirely offline, so it's reliable)
-  - Used by popular clients: [WebTorrent](http://webtorrent.io), [peerflix](https://github.com/mafintosh/peerflix), and [playback](https://mafintosh.github.io/playback/)
+  - Used by popular clients: [WebTorrent](http://webtorrent.io), [peerflix](https://www.npmjs.com/package/peerflix), and [playback](https://mafintosh.github.io/playback/)
 - Tracker statistics available via web interface at `/stats` or JSON data at `/stats.json`
 
-Also see [bittorrent-dht](https://github.com/feross/bittorrent-dht).
+Also see [bittorrent-dht](https://www.npmjs.com/package/bittorrent-dht).
+
+### Tracker stats
+
+![Screenshot](img/trackerStats.png)
 
 ## install
 
@@ -61,10 +67,12 @@ var requiredOpts = {
 var optionalOpts = {
   // RTCPeerConnection config object (only used in browser)
   rtcConfig: {},
-  // custom webrtc impl, useful in node to specify [wrtc](https://npmjs.com/package/wrtc)
+  // User-Agent header for http requests
+  userAgent: '',
+  // Custom webrtc impl, useful in node to specify [wrtc](https://npmjs.com/package/wrtc)
   wrtc: {},
   getAnnounceOpts: function () {
-    // provide a callback that will be called whenever announce() is called
+    // Provide a callback that will be called whenever announce() is called
     // internally (on timer), or by the user
     return {
       uploaded: 0,
@@ -73,7 +81,7 @@ var optionalOpts = {
       customParam: 'blah' // custom parameters supported
     }
   },
-  
+  // Proxy config object
   proxyOpts: {
       // Socks proxy options (used to proxy requests in node)
       socksProxy: {
@@ -110,7 +118,7 @@ var optionalOpts = {
       // Populated with Socks.Agent if socksProxy is provided
       httpAgent: {},
       httpsAgent: {}
-  }
+  },
 }
 
 var client = new Client(requiredOpts)
@@ -193,10 +201,14 @@ var server = new Server({
     // This example only allows one torrent.
 
     var allowed = (infoHash === 'aaa67059ed6bd08362da625b3ae77f6f4a075aaa')
-    cb(allowed)
-
-    // In addition to returning a boolean (`true` for allowed, `false` for disallowed),
-    // you can return an `Error` object to disallow and provide a custom reason.
+    if (allowed) {
+      // If the callback is passed `null`, the torrent will be allowed.
+      cb(null)
+    } else {
+      // If the callback is passed an `Error` object, the torrent will be disallowed
+      // and the error's `message` property will be given as the reason.
+      cb(new Error('disallowed torrent'))
+    }
   }
 })
 
@@ -255,7 +267,7 @@ Scraping multiple torrent info is possible with a static `Client.scrape` method:
 
 ```js
 var Client = require('bittorrent-tracker')
-Client.scrape(announceUrl, [ infoHash1, infoHash2 ], function (err, results) {
+Client.scrape({ announce: announceUrl, infoHash: [ infoHash1, infoHash2 ]}, function (err, results) {
   results[infoHash1].announce
   results[infoHash1].infoHash
   results[infoHash1].complete
@@ -268,6 +280,12 @@ Client.scrape(announceUrl, [ infoHash1, infoHash2 ], function (err, results) {
 
 ## command line
 
+Install `bittorrent-tracker` globally:
+
+```sh
+$ npm install -g bittorrent-tracker
+```
+
 Easily start a tracker server:
 
 ```sh
@@ -298,10 +316,8 @@ $ bittorrent-tracker --help
     -q, --quiet          only show error output
     -s, --silent         show no output
     -v, --version        print the current version
-
-  Please report bugs!  https://github.com/feross/bittorrent-tracker/issues
 ```
 
 ## license
 
-MIT. Copyright (c) [Feross Aboukhadijeh](http://feross.org).
+MIT. Copyright (c) [Feross Aboukhadijeh](https://feross.org) and [WebTorrent, LLC](https://webtorrent.io).

bin/cmd.js

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
 
-var minimist = require('minimist')
-var Server = require('../').Server
+const minimist = require('minimist')
+const Server = require('../').Server
 
-var argv = minimist(process.argv.slice(2), {
+const argv = minimist(process.argv.slice(2), {
   alias: {
     h: 'help',
     p: 'port',
@@ -63,22 +63,20 @@ if (argv.help) {
     -s, --silent                  show no output
     -v, --version                 print the current version
 
-  Please report bugs!  https://github.com/feross/bittorrent-tracker/issues
-
   */
   }.toString().split(/\n/).slice(2, -2).join('\n'))
   process.exit(0)
 }
 
 if (argv.silent) argv.quiet = true
 
-var allFalsy = !argv.http && !argv.udp && !argv.ws
+const allFalsy = !argv.http && !argv.udp && !argv.ws
 
 argv.http = allFalsy || argv.http
 argv.udp = allFalsy || argv.udp
 argv.ws = allFalsy || argv.ws
 
-var server = new Server({
+const server = new Server({
   http: argv.http,
   interval: argv.interval,
   stats: argv.stats,
@@ -106,41 +104,41 @@ server.on('stop', function (addr) {
   if (!argv.quiet) console.log('stop: ' + addr)
 })
 
-var hostname = {
+const hostname = {
   http: argv['http-hostname'],
   udp4: argv['udp-hostname'],
-  udp6: argv['upd6-hostname']
+  udp6: argv['udp6-hostname']
 }
 
 server.listen(argv.port, hostname, function () {
   if (server.http && argv.http && !argv.quiet) {
-    var httpAddr = server.http.address()
-    var httpHost = httpAddr.address !== '::' ? httpAddr.address : 'localhost'
-    var httpPort = httpAddr.port
+    const httpAddr = server.http.address()
+    const httpHost = httpAddr.address !== '::' ? httpAddr.address : 'localhost'
+    const httpPort = httpAddr.port
     console.log('HTTP tracker: http://' + httpHost + ':' + httpPort + '/announce')
   }
   if (server.udp && !argv.quiet) {
-    var udpAddr = server.udp.address()
-    var udpHost = udpAddr.address
-    var udpPort = udpAddr.port
+    const udpAddr = server.udp.address()
+    const udpHost = udpAddr.address
+    const udpPort = udpAddr.port
     console.log('UDP tracker: udp://' + udpHost + ':' + udpPort)
   }
   if (server.udp6 && !argv.quiet) {
-    var udp6Addr = server.udp6.address()
-    var udp6Host = udp6Addr.address !== '::' ? udp6Addr.address : 'localhost'
-    var udp6Port = udp6Addr.port
+    const udp6Addr = server.udp6.address()
+    const udp6Host = udp6Addr.address !== '::' ? udp6Addr.address : 'localhost'
+    const udp6Port = udp6Addr.port
     console.log('UDP6 tracker: udp://' + udp6Host + ':' + udp6Port)
   }
   if (server.ws && !argv.quiet) {
-    var wsAddr = server.http.address()
-    var wsHost = wsAddr.address !== '::' ? wsAddr.address : 'localhost'
-    var wsPort = wsAddr.port
+    const wsAddr = server.http.address()
+    const wsHost = wsAddr.address !== '::' ? wsAddr.address : 'localhost'
+    const wsPort = wsAddr.port
     console.log('WebSocket tracker: ws://' + wsHost + ':' + wsPort)
   }
   if (server.http && argv.stats && !argv.quiet) {
-    var statsAddr = server.http.address()
-    var statsHost = statsAddr.address !== '::' ? statsAddr.address : 'localhost'
-    var statsPort = statsAddr.port
+    const statsAddr = server.http.address()
+    const statsHost = statsAddr.address !== '::' ? statsAddr.address : 'localhost'
+    const statsPort = statsAddr.port
     console.log('Tracker stats: http://' + statsHost + ':' + statsPort + '/stats')
   }
 })