Synchronization cleanup

README.md

@@ -65,12 +65,15 @@ Once that is done, a new proxy will be available on the port returned. All you h
   - method - regular expression for matching method., e.g., POST. Emtpy for matching all method.
  - DELETE /proxy/[port]/blacklist - Clears all URL patterns from the blacklist
  - PUT /proxy/[port]/limit - Limit the bandwidth through the proxy. Takes the following parameters:
-  - downstreamKbps - Sets the downstream kbps
-  - upstreamKbps - Sets the upstream kbps
+  - downstreamKbps - Sets the downstream bandwidth limit in kbps
+  - upstreamKbps - Sets the upstream bandwidth limit kbps
+  - downstreamMaxKB - Specifies how many kilobytes in total the client is allowed to download through the proxy.
+  - upstreamMaxKB - Specifies how many kilobytes in total the client is allowed to upload through the proxy.
   - latency - Add the given latency to each HTTP request
   - enable - (true/false) a boolean that enable bandwidth limiter. By default the limit is disabled, although setting any of the properties above will implicitly enable throttling
   - payloadPercentage - a number ]0, 100] specifying what percentage of data sent is payload. e.g. use this to take into account overhead due to tcp/ip.
   - maxBitsPerSecond - The max bits per seconds you want this instance of StreamManager to respect.
+ - GET /proxy/[port]/limit - Displays the amount of data remaining to be uploaded/downloaded until the limit is reached.
  - POST /proxy/[port]/headers - Set and override HTTP Request headers. For example setting a custom User-Agent.
   - Payload data should be json encoded set of headers (not url-encoded)
  - POST /proxy/[port]/hosts - Overrides normal DNS lookups and remaps the given hosts with the associated IP address
@@ -119,12 +122,14 @@ system properties will be used to specify the upstream proxy.
 Command-line Arguments
 ----------------------
 
- - -port <port>
+ - -port \<port\>
   - Port on which the API listens. Default value is 8080.
  - -address <address>
   - Address to which the API is bound. Default value is 0.0.0.0.
- - -proxyPortRange <from>-<to>
-  - Range of ports reserved for proxies. Only applies if *port* parameter is not supplied in the POST request. Default values are <port>+1 to <port>+500+1.
+ - -proxyPortRange \<from\>-\<to\>
+  - Range of ports reserved for proxies. Only applies if *port* parameter is not supplied in the POST request. Default values are \<port\>+1 to \<port\>+500+1.
+ - -ttl \<seconds\>
+  - Proxy will be automatically deleted after a specified time period. Off by default.
 
 Embedded Mode
 -------------

pom.xml

@@ -39,6 +39,20 @@
         <developerConnection>scm:git:git@github.com:lightbody/browsermob-proxy.git</developerConnection>
         <url>git@github.com:lightbody/browsermob-proxy.git</url>
     </scm>
+
+    <repositories>
+        <repository>
+            <id>guiceyfruit.release</id>
+            <name>GuiceyFruit Release Repository</name>
+            <url>http://guiceyfruit.googlecode.com/svn/repo/releases/</url>
+            <snapshots>
+                <enabled>false</enabled>
+            </snapshots>
+            <releases>
+                <enabled>true</enabled>
+            </releases>
+        </repository>
+    </repositories>
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@@ -249,6 +263,12 @@
             <artifactId>guice-servlet</artifactId>
             <version>3.0</version>
         </dependency>
+
+        <dependency>
+            <groupId>org.guiceyfruit</groupId>
+            <artifactId>guiceyfruit-core</artifactId>
+            <version>2.0</version>                       
+        </dependency>
 
         <dependency>
             <groupId>net.jcip</groupId>
@@ -294,7 +314,7 @@
         <dependency>
             <groupId>net.sf.uadetector</groupId>
             <artifactId>uadetector-resources</artifactId>
-            <version>2013.10</version>
+            <version>2014.09</version>
         </dependency>
         <dependency>
             <groupId>org.jboss.arquillian.extension</groupId>

src/main/java/net/lightbody/bmp/proxy/BlacklistEntry.java

@@ -2,27 +2,64 @@
 
 import java.util.regex.Pattern;
 
-public class BlacklistEntry
-{
-    private Pattern pattern;
-    private int responseCode;
-	private Pattern method;
+public class BlacklistEntry {
+	private final Pattern pattern;
+	private final int responseCode;
+	private final Pattern method;
 
-    public BlacklistEntry(String pattern, int responseCode, String method) {
-        this.pattern = Pattern.compile(pattern);
-        this.responseCode = responseCode;
-		this.method = Pattern.compile(("".equals(method) || method == null) ? ".*" : method);
-    }
+	/**
+	 * Creates a new BlacklistEntry with no HTTP method matching (i.e. all methods will match).
+	 * 
+	 * @param pattern URL pattern to blacklist
+	 * @param responseCode response code to return for blacklisted URL
+	 */
+	public BlacklistEntry(String pattern, int responseCode) {
+		this(pattern, responseCode, null);
+	}
+
+	/**
+	 * Creates a new BlacklistEntry which will match both a URL and an HTTP method
+	 * 
+	 * @param pattern URL pattern to blacklist
+	 * @param responseCode response code to return for blacklisted URL
+	 * @param method HTTP method to match (e.g. GET, PUT, PATCH, etc.)
+	 */
+	public BlacklistEntry(String pattern, int responseCode, String method) {
+		this.pattern = Pattern.compile(pattern);
+		this.responseCode = responseCode;
+		if (method == null || method.isEmpty()) {
+			this.method = null;
+		} else {
+			this.method = Pattern.compile(method);
+		}
+	}
+
+	/**
+	 * Determines if this BlacklistEntry matches the given URL. Attempts to match both the URL and the 
+	 * HTTP method.
+	 * 
+	 * @param url possibly-blacklisted URL
+	 * @param httpMethod HTTP method this URL is being accessed with
+	 * @return true if the URL matches this BlacklistEntry
+	 */
+	public boolean matches(String url, String httpMethod) {
+		if (method != null) {
+			return pattern.matcher(url).matches() && method.matcher(httpMethod).matches();
+		} else {
+			return pattern.matcher(url).matches();
+		}
+	}
 
-    public Pattern getPattern() {
-        return this.pattern;
-    }
+	public Pattern getPattern() {
+		return this.pattern;
+	}
+
+	public int getResponseCode() {
+		return responseCode;
+	}
 
-    public int getResponseCode() {
-        return this.responseCode;
-    }
-
 	public Pattern getMethod() {
-		return this.method;
+		return method;
 	}
-}
+
+}

src/main/java/net/lightbody/bmp/proxy/Main.java

@@ -4,20 +4,6 @@
 import com.google.inject.Injector;
 import com.google.inject.servlet.GuiceServletContextListener;
 import com.google.sitebricks.SitebricksModule;
-
-import net.lightbody.bmp.exception.JettyException;
-import net.lightbody.bmp.proxy.bricks.ProxyResource;
-import net.lightbody.bmp.proxy.guice.ConfigModule;
-import net.lightbody.bmp.proxy.guice.JettyModule;
-import net.lightbody.bmp.proxy.util.StandardFormatter;
-
-import org.eclipse.jetty.server.Server;
-import org.eclipse.jetty.servlet.ServletContextHandler;
-import org.eclipse.jetty.util.log.Log;
-import org.slf4j.LoggerFactory;
-
-import javax.servlet.ServletContextEvent;
-
 import java.io.FileInputStream;
 import java.io.FileNotFoundException;
 import java.io.IOException;
@@ -28,6 +14,17 @@
 import java.util.logging.Level;
 import java.util.logging.LogManager;
 import java.util.logging.Logger;
+import javax.servlet.ServletContextEvent;
+import net.lightbody.bmp.exception.JettyException;
+import net.lightbody.bmp.proxy.bricks.ProxyResource;
+import net.lightbody.bmp.proxy.guice.ConfigModule;
+import net.lightbody.bmp.proxy.guice.JettyModule;
+import net.lightbody.bmp.proxy.util.StandardFormatter;
+import org.eclipse.jetty.server.Server;
+import org.eclipse.jetty.servlet.ServletContextHandler;
+import org.eclipse.jetty.util.log.Log;
+import org.guiceyfruit.jsr250.Jsr250Module;
+import org.slf4j.LoggerFactory;
 
 public class Main {
     private static final String LOGGING_PROPERTIES_FILENAME = "conf/bmp-logging.properties";
@@ -38,7 +35,7 @@ public class Main {
     public static void main(String[] args) {
         configureJdkLogging();
 
-        final Injector injector = Guice.createInjector(new ConfigModule(args), new JettyModule(), new SitebricksModule() {
+        final Injector injector = Guice.createInjector(new ConfigModule(args), new Jsr250Module(), new JettyModule(), new SitebricksModule() {
             @Override
             protected void configureSitebricks() {
                 scan(ProxyResource.class.getPackage());
@@ -148,4 +145,4 @@ private static void configureDefaultLogger() {
         logger.addHandler(handler);
 	}
 }
-
+

src/main/java/net/lightbody/bmp/proxy/ProxyManager.java

@@ -3,14 +3,16 @@
 import com.google.inject.Inject;
 import com.google.inject.Provider;
 import com.google.inject.Singleton;
-
 import com.google.inject.name.Named;
-
 import java.net.InetAddress;
 import java.net.UnknownHostException;
 import java.util.Collection;
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.ConcurrentMap;
+import javax.annotation.PreDestroy;
+
+import net.lightbody.bmp.proxy.util.ExpirableMap;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -22,15 +24,28 @@ public class ProxyManager {
     private int lastPort;
     private final int minPort; 
     private final int maxPort;
-    private Provider<ProxyServer> proxyServerProvider;
-    private ConcurrentHashMap<Integer, ProxyServer> proxies = new ConcurrentHashMap<Integer, ProxyServer>();
+    private final Provider<ProxyServer> proxyServerProvider;
+    private final ConcurrentMap<Integer, ProxyServer> proxies;
 
     @Inject
-    public ProxyManager(Provider<ProxyServer> proxyServerProvider, @Named("minPort") Integer minPort, @Named("maxPort") Integer maxPort) {
+    public ProxyManager(Provider<ProxyServer> proxyServerProvider, @Named("minPort") Integer minPort, @Named("maxPort") Integer maxPort, @Named("ttl") Integer ttl) {
         this.proxyServerProvider = proxyServerProvider;
         this.minPort = minPort;
         this.maxPort = maxPort;
         this.lastPort = maxPort; 
+        this.proxies = ttl > 0 ?                
+                new ExpirableMap<Integer, ProxyServer>(ttl, new ExpirableMap.OnExpire<ProxyServer>(){
+                    @Override
+                    public void run(ProxyServer proxy) {
+                        try {
+                            LOG.debug("Expiring ProxyServer `{}`...", proxy.getPort());
+                            proxy.stop();
+                        } catch (Exception ex) {
+                            LOG.warn("Error while stopping an expired proxy", ex);
+                        }
+                    }
+                }) : 
+                new ConcurrentHashMap<Integer, ProxyServer>();    
     }
 
     public ProxyServer create(Map<String, String> options, Integer port, String bindAddr) {
@@ -115,4 +130,11 @@ public void delete(int port) {
         ProxyServer proxy = proxies.remove(port);
         proxy.stop();
     }
+
+    @PreDestroy
+    public void stop(){
+        if(proxies instanceof ExpirableMap){                   
+            ((ExpirableMap)proxies).stop();
+        }
+    }
 }