Add Strategy Pattern in the piece selection algorithm

.gitignore

@@ -3,6 +3,7 @@
 
 # Ignore build output
 /build/*
+/release.properties
 
 # Ignore Javadoc output
 /doc/*
@@ -18,3 +19,4 @@
 *.bak
 *~
 *~
+/build/

.travis.yml

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

README.md

@@ -1,6 +1,8 @@
 Ttorrent, a Java implementation of the BitTorrent protocol
 ==========================================================
 
+[![Build Status](https://travis-ci.org/mpetazzoni/ttorrent.png)](https://travis-ci.org/mpetazzoni/ttorrent)
+
 Description
 -----------
 
@@ -28,6 +30,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.
+
+About the Fork
+=============
+
+This fork was created to allow Java Programmers to choose their own piece selection algorithm. In my own very case, I wanted to download the first pieces first (because I was working in a streaming system like Popcorn-time), so I created the IndexFirstStrategy. The RareFirstStrategy was created by the original author, I just extrated his code from the Piece class and put in the RareFirstStrategy class.
+
 
 History
 -------
@@ -65,6 +73,22 @@ usage message on the console when invoked with the ``-h`` command-line flag.
 
 ### As a library
 
+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>com.turn</groupId>
+      <artifactId>ttorrent</artifactId>
+      <version>1.4</version>
+    </dependency>
+  </dependencies>
+```
+
 *Thanks to Anatoli Vladev for the code examples in #16.*
 
 #### Client code
@@ -80,7 +104,17 @@ Client client = new Client(
   // output directory. Partials downloads are automatically recovered.
   SharedTorrent.fromFile(
     new File("/path/to/your.torrent"),
-    new File("/path/to/output/directory")));
+    new File("/path/to/output/directory")),
+
+    //An implementation of PieceSelectionStrategy
+    //The RareFirstStrategy is the most commom one
+    new RareFirstStrategy());
+
+// You can optionally set download/upload rate limits
+// in kB/second. Setting a limit to 0.0 disables rate
+// limits.
+client.setMaxDownloadRate(50.0);
+client.setMaxUploadRate(50.0);
 
 // At this point, can you either call download() to download the torrent and
 // stop immediately after...
@@ -134,20 +168,23 @@ License version 2.0. See COPYING file for more details.
 Authors and contributors
 ------------------------
 
-* Maxime Petazzoni <<[email protected]>> (Platform Engineer at Turn, Inc)  
+* Maxime Petazzoni <<[email protected]>> (Software Engineer at SignalFuse, Inc)  
   Original author, main developer and maintainer
 * David Giffin <<[email protected]>>  
   Contributed parallel hashing and multi-file torrent support.
 * Thomas Zink <<[email protected]>>  
   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  
   Contributed the switch from Ant to Maven.
 * Alexey Ptashniy  
   Fixed an integer overflow in the calculation of a torrent's full size.
+* Elias Granja <<[email protected]>>
+
+	Contributed with the Strategy Pattern.
 
 
 Caveats

bin/ttorrent

@@ -0,0 +1,73 @@
+#!/bin/sh
+
+# Copyright (C) 2012 Turn, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+EXECJAR="ttorrent-*-shaded.jar"
+
+real_path() {
+    case $1 in
+        /*)
+            SCRIPT="$1"
+            ;;
+        *)
+            PWD=`pwd`
+            SCRIPT="$PWD/$1"
+            ;;
+    esac
+    CHANGED=true
+    while [ "X$CHANGED" != "X" ] ; do
+        # Change spaces to ":" so the tokens can be parsed.
+        SAFESCRIPT=`echo $SCRIPT | sed -e 's; ;:;g'`
+        # Get the real path to this script, resolving any symbolic links
+        TOKENS=`echo $SAFESCRIPT | sed -e 's;/; ;g'`
+        REALPATH=
+        for C in $TOKENS; do
+            # Change any ":" in the token back to a space.
+            C=`echo $C | sed -e 's;:; ;g'`
+            REALPATH="$REALPATH/$C"
+            # If REALPATH is a sym link, resolve it.  Loop for nested links.
+            while [ -h "$REALPATH" ] ; do
+                LS="`ls -ld "$REALPATH"`"
+                LINK="`expr "$LS" : '.*-> \(.*\)$'`"
+                if expr "$LINK" : '/.*' > /dev/null; then
+                    # LINK is absolute.
+                    REALPATH="$LINK"
+                else
+                    # LINK is relative.
+                    REALPATH="`dirname "$REALPATH"`""/$LINK"
+                fi
+            done
+        done
+        if [ "$REALPATH" = "$SCRIPT" ] ; then
+            CHANGED=""
+        else
+            SCRIPT="$REALPATH"
+        fi
+    done
+    echo "$REALPATH"
+}
+
+base=$(dirname $(real_path $0))
+CPARG=$(find ${base}/../build -name "$EXECJAR" | tail -n 1)
+if [ -z "$CPARG" ] ; then
+    echo "Unable to find $EXECJAR"
+    exit 1
+fi
+if [ -z "$MAINCLASS" ] ; then
+    CPARG="-jar $CPARG"
+else
+    CPARG="-cp $CPARG $MAINCLASS"
+fi
+exec java $CPARG "$@"

bin/client → bin/ttorrent-torrent

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/sh
 
 # Copyright (C) 2012 Turn, Inc.
 #
@@ -14,5 +14,5 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-base=$(dirname $(readlink -f $0))
-exec java -jar $(find ${base}/../build -name "ttorrent-*.jar" | tail -n 1) $*
+EXEFILE="${0%-torrent}"
+MAINCLASS="com.turn.ttorrent.cli.TorrentMain" "${EXEFILE}" "$@"

bin/torrent → bin/ttorrent-tracker

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/sh
 
 # Copyright (C) 2012 Turn, Inc.
 #
@@ -14,5 +14,5 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-base=$(dirname $(readlink -f $0))
-exec java -cp $(find ${base}/../build -name "ttorrent-*.jar" | tail -n 1) com.turn.ttorrent.common.Torrent $*
+EXEFILE="${0%-tracker}"
+MAINCLASS="com.turn.ttorrent.cli.TrackerMain" "${EXEFILE}" "$@"

pom.xml

@@ -1,11 +1,11 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-		xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 
 	<parent>
 		<groupId>org.sonatype.oss</groupId>
 		<artifactId>oss-parent</artifactId>
 		<version>7</version>
+		<relativePath />
 	</parent>
 
 	<name>Java BitTorrent library</name>
@@ -14,20 +14,17 @@
 		including support for several BEPs. It also provides a standalone client,
 		a tracker and a torrent manipulation utility.
 	</description>
-	<url>http://turn.github.com/ttorrent/</url>
+	<url>http://mpetazzoni.github.io/ttorrent/</url>
 	<groupId>com.turn</groupId>
 	<artifactId>ttorrent</artifactId>
-	<version>1.2</version>
+	<version>1.5-SNAPSHOT</version>
 	<packaging>jar</packaging>
 
-	<organization>
-		<name>Turn, Inc.</name>
-		<url>http://www.turn.com</url>
-	</organization>
-
 	<scm>
-		<connection>scm:git:git://github.com/turn/ttorrent.git</connection>
-		<url>http://github.com/turn/ttorrent</url>
+		<connection>scm:git:git://github.com/mpetazzoni/ttorrent.git</connection>
+		<developerConnection>scm:git:ssh://[email protected]/mpetazzoni/ttorrent.git</developerConnection>
+		<url>http://github.com/mpetazzoni/ttorrent</url>
+		<tag>master</tag>
 	</scm>
 
 	<licenses>
@@ -39,17 +36,17 @@
 
 	<issueManagement>
 		<system>GitHub</system>
-		<url>https://github.com/turn/ttorrent/issues</url>
+		<url>https://github.com/mpetazzoni/ttorrent/issues</url>
 	</issueManagement>
 
 	<developers>
 		<developer>
 			<id>mpetazzoni</id>
 			<name>Maxime Petazzoni</name>
-			<email>[email protected]</email>
+			<email>[email protected]</email>
 			<url>http://www.bulix.org</url>
-			<organization>Turn, Inc</organization>
-			<organizationUrl>http://www.turn.com</organizationUrl>
+			<organization>SignalFuse, Inc</organization>
+			<organizationUrl>http://www.signalfuse.com</organizationUrl>
 			<roles>
 				<role>maintainer</role>
 				<role>architect</role>
@@ -75,10 +72,16 @@
 	</repositories>
 
 	<dependencies>
+		<dependency>
+			<groupId>commons-codec</groupId>
+			<artifactId>commons-codec</artifactId>
+			<version>1.8</version>
+		</dependency>
+
 		<dependency>
 			<groupId>commons-io</groupId>
 			<artifactId>commons-io</artifactId>
-			<version>2.1</version>
+			<version>2.4</version>
 		</dependency>
 
 		<dependency>
@@ -127,6 +130,11 @@
 				<artifactId>maven-jar-plugin</artifactId>
 				<version>2.4</version>
 				<configuration>
+					<archive>
+						<manifest>
+							<addDefaultImplementationEntries>true</addDefaultImplementationEntries>
+						</manifest>
+					</archive>
 					<includes>
 						<include>**</include>
 					</includes>
@@ -144,28 +152,30 @@
 			</plugin>
 
 			<plugin>
-				<artifactId>maven-assembly-plugin</artifactId>
-				<configuration>
-					<descriptorRefs>
-						<descriptorRef>jar-with-dependencies</descriptorRef>
-					</descriptorRefs>
-					<appendAssemblyId>false</appendAssemblyId>
-					<archive>
-						<manifest>
-							<addClasspath>false</addClasspath>
-							<addDefaultImplementationEntries>true</addDefaultImplementationEntries>
-							<mainClass>com.turn.ttorrent.client.Client</mainClass>
-						</manifest>
-					</archive>
-				</configuration>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-release-plugin</artifactId>
+				<version>2.4.2</version>
+			</plugin>
+
+			<plugin>
+				<artifactId>maven-shade-plugin</artifactId>
+				<version>2.1</version>
 				<executions>
 					<execution>
-						<id>make-my-jar-with-dependencies</id>
 						<phase>package</phase>
 						<goals>
-							<!--change assembly to single if you don't want include dependencies in jar-->
-							<goal>assembly</goal>
+							<goal>shade</goal>
 						</goals>
+						<configuration>
+							<outputFile>${project.build.directory}/${project.artifactId}-${project.version}-shaded.jar</outputFile>
+							<transformers>
+								<transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
+									<manifestEntries>
+										<Main-Class>com.turn.ttorrent.cli.ClientMain</Main-Class>
+									</manifestEntries>
+								</transformer>
+							</transformers>
+						</configuration>
 					</execution>
 				</executions>
 			</plugin>

src/main/java/com/turn/ttorrent/bcodec/BDecoder.java

@@ -206,7 +206,7 @@ public BEValue bdecodeNumber() throws IOException {
 			c = this.read();
 			if (c == '0')
 				throw new InvalidBEncodingException("Negative zero not allowed");
-			chars[off] = (char)c;
+			chars[off] = '-';
 			off++;
 		}