Disable reputation enforcement for subscribers.

Author: MClarkDev

src/main/java/org/barcodeapi/server/admin/LimiterListHandler.java

@@ -46,19 +46,19 @@ protected void onRequest(RequestContext c, HttpServletResponse r) throws JSONExc
 
 			// Add all to map if no filters applied
 			if (!filtered) {
-				byKey.put(limiter.getCaller(), limiter.getTokens().getTotalSpend());
+				byKey.put(limiter.getCallerID(), limiter.getTokens().getTotalSpend());
 				continue;
 			}
 
 			// Conditionally filter based on low reputation status
 			if (filterReputation && limiter.getReputation().isAbuser()) {
-				byKey.put(limiter.getCaller(), limiter.getReputation().value());
+				byKey.put(limiter.getCallerID(), limiter.getReputation().value());
 				continue;
 			}
 
 			// Conditionally filter based on low tokens count
 			if (filterTokenLimit && limiter.getTokens().isLowBalance()) {
-				byKey.put(limiter.getCaller(), limiter.getTokens().getCount());
+				byKey.put(limiter.getCallerID(), limiter.getTokens().getCount());
 			}
 		}
 

src/main/java/org/barcodeapi/server/api/BarcodeAPIHandler.java

@@ -61,7 +61,7 @@ protected void onRequest(RequestContext c, HttpServletResponse r) throws IOExcep
 			// Check for abuse
 			if (limiter.getReputation().isAbuser()) {
 				throw new GenerationException(ExceptionType.ABUSE, new Throwable(String.format(//
-						"Bad reputation for IP, try again later. (u:%s)", limiter.getCaller())));
+						"Bad reputation for IP, try again later. (u:%s)", limiter.getCallerID())));
 			}
 
 			// Parse the request
@@ -78,7 +78,7 @@ protected void onRequest(RequestContext c, HttpServletResponse r) throws IOExcep
 
 				// Return rate limited barcode to user
 				throw new GenerationException(ExceptionType.LIMITED, new Throwable(String.format(//
-						"Client is rate limited, try again later. (u:%s)", limiter.getCaller())));
+						"Client is rate limited, try again later. (u:%s)", limiter.getCallerID())));
 			}
 
 			// Generate user requested barcode

src/main/java/org/barcodeapi/server/api/LimiterHandler.java

@@ -65,7 +65,7 @@ protected void doDELETE(RequestContext c, HttpServletResponse r) throws IOExcept
 		}
 
 		// Log the reset request
-		LibLog._logF("Limiter reset request: %s", c.getLimiter().getCaller());
+		LibLog._logF("Limiter reset request: %s", c.getLimiter().getCallerID());
 
 		// Reset the limiter balance to full
 		Tokens userTokens = c.getLimiter().getTokens();

src/main/java/org/barcodeapi/server/cache/CachedLimiter.java

@@ -1,5 +1,7 @@
 package org.barcodeapi.server.cache;
 
+import org.barcodeapi.core.Config;
+import org.barcodeapi.core.Config.Cfg;
 import org.barcodeapi.server.core.Reputation;
 import org.barcodeapi.server.core.Tokens;
 import org.json.JSONObject;
@@ -11,22 +13,43 @@
  */
 public class CachedLimiter extends CachedObject {
 
+	// Default values for new limiters
+	private static final int DEFLIMIT_RATE;
+	private static final boolean DEFLIMIT_ENFORCE;
+
+	static {
+
+		// Load plan from configuration
+		JSONObject freePlan = Config//
+				.get(Cfg.Plans).getJSONObject("free");
+
+		// Free plan defaults
+		DEFLIMIT_RATE = freePlan.getInt("limit");
+		DEFLIMIT_ENFORCE = freePlan.getBoolean("enforce");
+	}
+
 	private static final long serialVersionUID = 20260503L;
 
-	private final String caller;
+	private final String callerID;
 
 	private final Reputation reputation;
 
 	private final Tokens tokens;
 
-	public CachedLimiter(boolean enforce, String caller, long requests) {
+	public CachedLimiter(Subscriber sub, String address) {
 		super("limiter");
 
-		this.caller = caller;
+		// Assign the userID
+		this.callerID = (sub != null) ? sub.getCustomer() : address;
 
-		this.reputation = new Reputation(enforce);
+		// Determine token limits for the limiter
+		int limit = (sub != null) ? sub.getLimit() : DEFLIMIT_RATE;
+		boolean enforce = (sub != null) ? sub.isEnforced() : DEFLIMIT_ENFORCE;
+		this.tokens = new Tokens(enforce, limit);
 
-		this.tokens = new Tokens(enforce, requests);
+		// Setup user reputation tracker
+		boolean repBlock = (sub != null) ? false : enforce;
+		this.reputation = new Reputation(repBlock);
 	}
 
 	public void touch(CachedSession session) {
@@ -54,8 +77,8 @@ public boolean isShortLived() {
 	 * 
 	 * @return caller
 	 */
-	public String getCaller() {
-		return caller;
+	public String getCallerID() {
+		return callerID;
 	}
 
 	/**
@@ -101,7 +124,7 @@ public boolean onRequest(boolean valid, double cost) {
 	public JSONObject asJSON() {
 
 		return (new JSONObject()//
-				.put("caller", getCaller())//
+				.put("callerID", getCallerID())//
 				.put("requests", getAccessCount())//
 				.put("reputation", reputation.value())//
 				.put("time", new JSONObject() //

src/main/java/org/barcodeapi/server/cache/LimiterCache.java

@@ -1,9 +1,5 @@
 package org.barcodeapi.server.cache;
 
-import org.barcodeapi.core.Config;
-import org.barcodeapi.core.Config.Cfg;
-import org.json.JSONObject;
-
 import com.mclarkdev.tools.libmetrics.LibMetrics;
 
 /**
@@ -13,23 +9,11 @@
  */
 public class LimiterCache {
 
-	// Default values for new limiters
-	private static final int DEFLIMIT_RATE;
-	private static final boolean DEFLIMIT_ENFORCE;
-
 	// Local instance of the limiters cache
 	private static final ObjectCache _LIMITERS;
 
 	static {
 
-		// Load plan from configuration
-		JSONObject freePlan = Config//
-				.get(Cfg.Plans).getJSONObject("free");
-
-		// Free plan defaults
-		DEFLIMIT_RATE = freePlan.getInt("limit");
-		DEFLIMIT_ENFORCE = freePlan.getBoolean("enforce");
-
 		// Get the limiter cache
 		_LIMITERS = ObjectCache.getCache(ObjectCache.CACHE_LIMITERS);
 	}
@@ -44,23 +28,19 @@ public static CachedLimiter getLimiter(Subscriber sub, String address) {
 		LibMetrics.hitMethodRunCounter();
 
 		// User ID is customer or address
-		String userID = (sub != null) ? sub.getCustomer() : address;
+		String caller = (sub != null) ? sub.getCustomer() : address;
 
 		// Determine if limiter exists
 		CachedLimiter limiter;
-		if (_LIMITERS.has(userID)) {
+		if (_LIMITERS.has(caller)) {
 
 			// Get the existing limiter from the cache
-			limiter = (CachedLimiter) _LIMITERS.get(userID);
+			limiter = (CachedLimiter) _LIMITERS.get(caller);
 		} else {
 
-			// Determine enforce / limits for the new limiter
-			int limit = (sub != null) ? sub.getLimit() : DEFLIMIT_RATE;
-			boolean enforce = (sub != null) ? sub.isEnforced() : DEFLIMIT_ENFORCE;
-
 			// Create a new limiter and add it to the cache
-			limiter = new CachedLimiter(enforce, userID, limit);
-			_LIMITERS.put(userID, limiter);
+			limiter = new CachedLimiter(sub, address);
+			_LIMITERS.put(caller, limiter);
 		}
 
 		// Return the limiter

src/main/java/org/barcodeapi/server/core/RestHandler.java

@@ -160,7 +160,7 @@ public void handle(String target, Request baseRequest, HttpServletRequest reques
 		// Send token count to user
 		response.setHeader("X-RateLimit-Tokens", //
 				String.format("%.2f", ctx.getLimiter().getTokens().getCount()));
-		response.setHeader("X-RateLimit-Caller", ctx.getLimiter().getCaller());
+		response.setHeader("X-RateLimit-Caller", ctx.getLimiter().getCallerID());
 
 		// Request complete if only options
 		if (ctx.getMethod().equals("OPTIONS")) {

src/main/java/org/barcodeapi/server/tasks/ReputationDecayTask.java

@@ -45,7 +45,7 @@ public void onRun() {
 			if (rep.isAbuser()) {
 				LibLog.logF("reputation", //
 						"Reputation decay: %s has %.4f (+%.4f)", //
-						limiter.getCaller(), rep.value(), diff);
+						limiter.getCallerID(), rep.value(), diff);
 			}
 		}