SharedTorrent: Permit custom TorrentByteStorage implementations.

.gitignore

@@ -1,11 +1,9 @@
 # Git ignore patterns
 # Author: Maxime Petazzoni <mpetazzoni@turn.com>
+# Author: Shevek
 
 # Ignore build output
-/build/*
-
-# Ignore Javadoc output
-/doc/*
+build
 
 # Ignore any eventual Eclipse project files, these don't belong in the
 # repository.
@@ -18,3 +16,7 @@
 *.bak
 *~
 *~
+
+/.gradle
+/.nb-gradle
+

.travis.yml

@@ -0,0 +1 @@
+language: java

README.md

@@ -10,15 +10,23 @@ metainfo files creation and parsing capabilities. It is designed to be embedded
 into larger applications, but its components can also be used as standalone
 programs.
 
+This fork of ttorrent is a complete structural overhaul for
+correctness, improved performance using [Netty](http://netty.io/),
+vastly reduced memory consumption, monitoring and metrics, and
+optional integration with [Spring Framework](http://spring.io/) and
+[Jetty](http://www.eclipse.org/jetty/).
+
 Ttorrent supports the following BEPs (BitTorrent enhancement proposals):
 
-* `BEP#0003`: The BitTorrent protocol specification  
+* `BEP#0003`: The BitTorrent protocol specification (complete)
   This is the base official protocol specification, which Ttorrent implements
   fully.
+* `BEP#0007`: IPv6 Tracker Extension
+* `BEP#0010`: Extension Protocol
 * `BEP#0012`: Multi-tracker metadata extension  
   Full support for the `announce-list` meta-info key providing a tiered tracker
   list.
-* `BEP#0015`: UDP Tracker Protocol for BitTorrent  
+* `BEP#0015`: UDP Tracker Protocol for BitTorrent (partial)
   The UDP tracker protocol is fully supported in the BitTorrent client to make
   announce requests to UDP trackers. UDP tracker support itself is planned.
 * `BEP#0020`: Peer ID conventions  
@@ -28,6 +36,12 @@ Ttorrent supports the following BEPs (BitTorrent enhancement proposals):
   Compact peer lists are supported in both the client and the tracker.
   Currently the tracker only supports sending back compact peer lists
   to an announce request.
+* `BEP#0024`: Tracker Returns External IP
+
+In addition, the following extensions are supported:
+
+* Peer Exchange (ut\_pex) with PEX seeding for fast trackerless operation.
+* Linux epoll() (See ClientEnvironment#setEventLoopType()).
 
 History
 -------
@@ -44,15 +58,9 @@ to re-integrate into another application;
 * Snark's, which is old, and unfortunately unstable;
 * bitext, which was also unfortunately unstable, and extremely slow.
 
-This implementation aims at providing a down-to-earth, simple to use library.
-No fancy protocol extensions are implemented here: just the basics that allows
-for the exchange and distribution of files through the BitTorrent protocol.
-
-Although the write performance of the BitTorrent client is currently quite poor
-(~10MB/sec/connected peer), it has been measured that the distribution of a
-150MB file to thousands of machines across several datacenters took no more
-than 30 seconds, with very little network overhead for the initial seeder (only
-125% of the original file size uploaded by the initial seeder).
+The APIs and implementation were thoroughly overhauled in this fork,
+with the objective of sharing a multi-gigabyte file to a thousand
+hosts in a matter of seconds.
 
 
 How to use
@@ -65,65 +73,67 @@ usage message on the console when invoked with the ``-h`` command-line flag.
 
 ### As a library
 
-*Thanks to Anatoli Vladev for the code examples in #16.*
+To use ``ttorrent`` is a library in your project, all you need is to
+declare the dependency on the latest version of ``ttorrent``. For
+example, if you use Maven, add the following in your POM's dependencies
+section:
+
+```xml
+  <dependencies>
+    ...
+    <dependency>
+      <groupId>org.anarres.ttorrent</groupId>
+      <artifactId>ttorrent-client</groupId>
+      <version>1.8.0-SNAPSHOT</version>
+    </dependency>
+  </dependencies>
+```
 
 #### Client code
 
 ```java
 // First, instantiate the Client object.
-Client client = new Client(
-  // This is the interface the client will listen on (you might need something
-  // else than localhost here).
-  InetAddress.getLocalHost(),
-
-  // Load the torrent from the torrent file and use the given
-  // output directory. Partials downloads are automatically recovered.
-  SharedTorrent.fromFile(
-    new File("/path/to/your.torrent"),
-    new File("/path/to/output/directory")));
-
-// At this point, can you either call download() to download the torrent and
-// stop immediately after...
-client.download();
-
-// Or call client.share(...) with a seed time in seconds:
-// client.share(3600);
-// Which would seed the torrent for an hour after the download is complete.
-
-// Downloading and seeding is done in background threads.
-// To wait for this process to finish, call:
-client.waitForCompletion();
-
-// At any time you can call client.stop() to interrupt the download.
+Client client = new Client();
+
+// Configure the client as desired.
+client.getEnvironment.set*();
+
+// Add one or more torrents.
+Torrent torrent = new Torrent(new File("/path/to/your.torrent"))
+client.addTorrent(torrent, new File("/path/to/output/directory"));
+
+client.start();
+
 ```
+At any time you can call `client.stop()` to interrupt the download.
+You can also add a
+[ClientListener](ttorrent-client/src/main/java/com/turn/ttorrent/client/ClientListener.java)
+to wait for a download to complete.
 
 #### Tracker code
 
+For a tracker, there are a number of options:
+
+Standalone:
+
 ```java
-// First, instantiate a Tracker object with the port you want it to listen on.
-// The default tracker port recommended by the BitTorrent protocol is 6969.
-Tracker tracker = new Tracker(new InetSocketAddress(6969));
-
-// Then, for each torrent you wish to announce on this tracker, simply created
-// a TrackedTorrent object and pass it to the tracker.announce() method:
-FilenameFilter filter = new FilenameFilter() {
-  @Override
-  public boolean accept(File dir, String name) {
-    return name.endsWith(".torrent");
-  }
-};
-
-for (File f : new File("/path/to/torrent/files").listFiles(filter)) {
-  tracker.announce(TrackedTorrent.load(f));
-}
-
-// Once done, you just have to start the tracker's main operation loop:
+SimpleTracker tracker = new SimpleTracker(new InetSocketAddress(6969));
+tracker.addTorrent(new Torrent("/path/to/file"));
 tracker.start();
 
 // You can stop the tracker when you're done with:
 tracker.stop();
 ```
 
+Servlets/Jetty: See [TrackerServlet](ttorrent-tracker-servlet/src/main/java/com/turn/ttorrent/tracker/servlet/TrackerServlet.java).
+
+Spring Framework: See [TrackerController](ttorrent-tracker-spring/src/main/java/com/turn/ttorrent/tracker/spring/TrackerController.java).
+
+#### JavaDoc API
+
+The [JavaDoc API](http://shevek.github.io/ttorrent/docs/javadoc/)
+is available.
+
 License
 -------
 
@@ -134,14 +144,14 @@ License version 2.0. See COPYING file for more details.
 Authors and contributors
 ------------------------
 
-* Maxime Petazzoni <<mpetazzoni@turn.com>> (Platform Engineer at Turn, Inc)  
+* Maxime Petazzoni <<maxime.petazzoni@bulix.org>> (Software Engineer at SignalFuse, Inc)  
   Original author, main developer and maintainer
 * David Giffin <<david@etsy.com>>  
   Contributed parallel hashing and multi-file torrent support.
 * Thomas Zink <<thomas.zink@uni-konstanz.de>>  
   Fixed a piece length computation issue when the total torrent size is an
   exact multiple of the piece size.
-* Johan Parent <<parent_johan@yahoo.com>>  
+* Johan Parent <<parent\_johan@yahoo.com>>  
   Fixed a bug in unfresh peer collection and issues on download completion on
   Windows platforms.
 * Dmitriy Dumanskiy  
@@ -153,8 +163,5 @@ Authors and contributors
 Caveats
 -------
 
-* Client write performance is a bit poor, mainly due to a (too?) simple piece
-  caching algorithm.
-
 Contributions are welcome in all areas, even more so for these few points
 above!

TODO

@@ -0,0 +1,9 @@
+Code required:
+
+1) Protocol extension to specify maximum block size - we want 1Mb.
+2) Keepalives.
+
+Tests required:
+
+Connect to peers which never offer anything.  Make sure rarestPiece is null.
+