Add option to deny extending when over rent/total limits

Turned on by default, added config setting
'allowRegionExtendsWhenAboveLimits' to disable this change. Normally
this is expected behaviour, which pushes users to let the region run out
if they should not be able to rent it anymore (was impossible to do
before).

Closes #41

AreaShop/pom.xml

@@ -139,7 +139,7 @@
 	    <artifactId>maven-antrun-plugin</artifactId>
 	    <configuration>
 	      <tasks>
-	        <copy file="./target/${project.build.finalName}.jar" tofile="C:\Games\Minecraft\Spigot 1.8.7\plugins\${project.build.finalName}.jar"/>
+	        <copy file="./target/${project.build.finalName}.jar" tofile="C:\Games\Minecraft\Spigot 1.8.8\plugins\${project.build.finalName}.jar"/>
 	      </tasks>
 	    </configuration>
 	    <executions>

AreaShop/src/main/java/nl/evolutioncoding/areashop/regions/BuyRegion.java

@@ -279,7 +279,7 @@ public class BuyRegion extends GeneralRegion {
 					return false;
 				}			
 				// Check region limits
-				LimitResult limitResult = this.limitsAllowBuying(player);
+				LimitResult limitResult = this.limitsAllow(RegionType.BUY, player);
 				AreaShop.debug("LimitResult: " + limitResult.toString());
 				if(!limitResult.actionAllowed()) {
 					if(limitResult.getLimitingFactor() == LimitType.TOTAL) {

AreaShop/src/main/java/nl/evolutioncoding/areashop/regions/GeneralRegion.java

@@ -124,7 +124,8 @@ public abstract class GeneralRegion implements GeneralRegionInterface {
 	public enum LimitType {		
 		RENTS("rents"),
 		BUYS("buys"),
-		TOTAL("total");
+		TOTAL("total"),
+		EXTEND("extend");
 		
 		private final String value;
 		private LimitType(String value) {
@@ -1761,127 +1762,60 @@ public abstract class GeneralRegion implements GeneralRegionInterface {
 
 	
 	// LIMIT FUNCTIONS
-	
 	/**
-	 * Check if the player can buy this region, detailed info in the result object
+	 * Check if the player can buy/rent this region, detailed info in the result object
+	 * @param type The type of region to check
 	 * @param player The player to check it for
 	 * @return LimitResult containing if it is allowed, why and limiting factor
 	 */
-	public LimitResult limitsAllowBuying(Player player) {
+	public LimitResult limitsAllow(RegionType type, Player player) {
-		if(player.hasPermission("areashop.limitbypass")) {
+		return limitsAllow(type, player, false);
-			return new LimitResult(true, null, 0, 0, null);
-		}		
-		// Get current total regions
-		List<GeneralRegion> totalRegions = new ArrayList<GeneralRegion>();
-		for(GeneralRegion region : plugin.getFileManager().getRegions()) {
-			if(region.isOwner(player)) {
-				totalRegions.add(region);
-			}
-		}
-		// Get currently bought regions
-		List<BuyRegion> buyRegions = new ArrayList<BuyRegion>();
-		for(GeneralRegion region : totalRegions) {
-			if(region.isBuyRegion()) {
-				buyRegions.add((BuyRegion)region);
-			}
-		}
-		// Check all limitgroups the player has
-		List<String> groups = new ArrayList<String>(plugin.getConfig().getConfigurationSection("limitGroups").getKeys(false));
-		while(!groups.isEmpty()) {
-			String group = groups.get(0);
-			if(player.hasPermission("areashop.limits." + group) && this.matchesLimitGroup(group)) {
-				int totalLimit = plugin.getConfig().getInt("limitGroups." + group + ".total");
-				int buysLimit = plugin.getConfig().getInt("limitGroups." + group + ".buys");
-				int totalCurrent = hasRegionsInLimitGroup(player, group, totalRegions);
-				int buysCurrent = hasBuyRegionsInLimitGroup(player, group, buyRegions);
-				if(totalLimit == -1) {
-					totalLimit = Integer.MAX_VALUE;
-				}
-				if(buysLimit == -1) {
-					buysLimit = Integer.MAX_VALUE;
-				}
-				String totalHighestGroup = group;
-				String buysHighestGroup = group;
-				groups.remove(group);
-				// Get the highest number from the groups of the same category
-				List<String> groupsCopy = new ArrayList<String>(groups);
-				for(String checkGroup : groupsCopy) {
-					if(player.hasPermission("areashop.limits." + checkGroup) && this.matchesLimitGroup(checkGroup)) {
-						if(limitGroupsOfSameCategory(group, checkGroup)) {
-							groups.remove(checkGroup);
-							int totalLimitOther = plugin.getConfig().getInt("limitGroups." + checkGroup + ".total");
-							int buyLimitOther = plugin.getConfig().getInt("limitGroups." + checkGroup + ".buys");
-							if(totalLimitOther > totalLimit) {
-								totalLimit = totalLimitOther; 
-								totalHighestGroup = checkGroup;
-							} else if(totalLimitOther == -1) {
-								totalLimit = Integer.MAX_VALUE;
-							}
-							if(buyLimitOther > buysLimit) {
-								buysLimit = buyLimitOther;
-								buysHighestGroup = checkGroup;
-							} else if(buyLimitOther == -1) {
-								buysLimit = Integer.MAX_VALUE;
-							}
-						}
-					} else {
-						groups.remove(checkGroup);
-					}
-				}
-				// Check if the limits stop the player from buying the region
-				if(totalCurrent >= totalLimit) {
-					return new LimitResult(false, LimitType.TOTAL, totalLimit, totalCurrent, totalHighestGroup);					
-				}
-				if(buysCurrent >= buysLimit) {
-					return new LimitResult(false, LimitType.BUYS, buysLimit, buysCurrent, buysHighestGroup);					
-				}				
-			}
-			groups.remove(group);
-		}		
-		return new LimitResult(true, null, 0, 0, null);
 	}
 	
 	/**
-	 * Check if the player can rent this region, detailed info in the result object
+	 * Check if the player can buy/rent this region, detailed info in the result object
+	 * @param type The type of region to check
 	 * @param player The player to check it for
+	 * @param extend Check for extending of rental regions
 	 * @return LimitResult containing if it is allowed, why and limiting factor
 	 */
-	public LimitResult limitsAllowRenting(Player player) {
+	public LimitResult limitsAllow(RegionType type, Player player, boolean extend) {
 		if(player.hasPermission("areashop.limitbypass")) {
 			return new LimitResult(true, null, 0, 0, null);
 		}
-		// Get current total regions
+		GeneralRegion exclude = null;
-		List<GeneralRegion> totalRegions = new ArrayList<GeneralRegion>();
+		if(extend) {
-		for(GeneralRegion region : plugin.getFileManager().getRegions()) {
+			exclude = this;
-			if(region.isOwner(player)) {
-				totalRegions.add(region);
-			}
 		}
-		// Get currently bought regions
+		String typePath = null;
-		List<RentRegion> rentRegions = new ArrayList<RentRegion>();
+		if(type == RegionType.RENT) {
-		for(GeneralRegion region : totalRegions) {
+			typePath = "rents";
-			if(region.isRentRegion()) {
+		} else {
-				rentRegions.add((RentRegion)region);
+			typePath = "buys";
-			}
 		}
 		// Check all limitgroups the player has
 		List<String> groups = new ArrayList<String>(plugin.getConfig().getConfigurationSection("limitGroups").getKeys(false));
 		while(!groups.isEmpty()) {
 			String group = groups.get(0);
 			if(player.hasPermission("areashop.limits." + group) && this.matchesLimitGroup(group)) {
-				AreaShop.debug(player.getName() + " has limitGroup: " + group);
 				int totalLimit = plugin.getConfig().getInt("limitGroups." + group + ".total");
-				int rentsLimit = plugin.getConfig().getInt("limitGroups." + group + ".rents");
+				int typeLimit = plugin.getConfig().getInt("limitGroups." + group + "."+typePath);
-				int totalCurrent = hasRegionsInLimitGroup(player, group, totalRegions);
+				AreaShop.debug("typeLimitOther="+typeLimit+", typePath="+typePath);
-				int rentsCurrent = hasRentRegionsInLimitGroup(player, group, rentRegions);
+				int totalCurrent = hasRegionsInLimitGroup(player, group, plugin.getFileManager().getRegions(), exclude);
+				int typeCurrent = 0;
+				if(type == RegionType.RENT) {
+					typeCurrent = hasRegionsInLimitGroup(player, group, plugin.getFileManager().getRents(), exclude);
+				} else {
+					typeCurrent = hasRegionsInLimitGroup(player, group, plugin.getFileManager().getBuys(), exclude);
+				}
 				if(totalLimit == -1) {
 					totalLimit = Integer.MAX_VALUE;
 				}
-				if(rentsLimit == -1) {
+				if(typeLimit == -1) {
-					rentsLimit = Integer.MAX_VALUE;
+					typeLimit = Integer.MAX_VALUE;
 				}
 				String totalHighestGroup = group;
-				String rentsHighestGroup = group;
+				String typeHighestGroup = group;
 				groups.remove(group);
 				// Get the highest number from the groups of the same category
 				List<String> groupsCopy = new ArrayList<String>(groups);
@@ -1890,18 +1824,18 @@ public abstract class GeneralRegion implements GeneralRegionInterface {
 						if(limitGroupsOfSameCategory(group, checkGroup)) {
 							groups.remove(checkGroup);
 							int totalLimitOther = plugin.getConfig().getInt("limitGroups." + checkGroup + ".total");
-							int rentLimitOther = plugin.getConfig().getInt("limitGroups." + checkGroup + ".rents");
+							int typeLimitOther = plugin.getConfig().getInt("limitGroups." + checkGroup + "."+typePath);
 							if(totalLimitOther > totalLimit) {
 								totalLimit = totalLimitOther; 
 								totalHighestGroup = checkGroup;
 							} else if(totalLimitOther == -1) {
 								totalLimit = Integer.MAX_VALUE;
 							}
-							if(rentLimitOther > rentsLimit) {
+							if(typeLimitOther > typeLimit) {
-								rentsLimit = rentLimitOther;
+								typeLimit = typeLimitOther;
-								rentsHighestGroup = checkGroup;
+								typeHighestGroup = checkGroup;
-							} else if(rentLimitOther == -1) {
+							} else if(typeLimitOther == -1) {
-								rentsLimit = Integer.MAX_VALUE;
+								typeLimit = Integer.MAX_VALUE;
 							}
 						}
 					} else {
@@ -1909,12 +1843,22 @@ public abstract class GeneralRegion implements GeneralRegionInterface {
 					}
 				}
 				// Check if the limits stop the player from buying the region
+				if(typeCurrent >= typeLimit) {
+					LimitType limitType = null;
+					if(type == RegionType.RENT) {
+						if(extend) {
+							limitType = LimitType.EXTEND;
+						} else {
+							limitType = LimitType.RENTS;
+						}
+					} else {
+						limitType = LimitType.BUYS;
+					}
+					return new LimitResult(false, limitType, typeLimit, typeCurrent, typeHighestGroup);					
+				}
 				if(totalCurrent >= totalLimit) {
 					return new LimitResult(false, LimitType.TOTAL, totalLimit, totalCurrent, totalHighestGroup);					
-				}
+				}		
-				if(rentsCurrent >= rentsLimit) {
-					return new LimitResult(false, LimitType.RENTS, rentsLimit, rentsCurrent, rentsHighestGroup);					
-				}				
 			}
 			groups.remove(group);
 		}		
@@ -1979,44 +1923,6 @@ public abstract class GeneralRegion implements GeneralRegionInterface {
 		return true;
 	}
 	
-	/**
-	 * Get the amount of buy regions a player has matching a certain limits group (config.yml > limitGroups)
-	 * @param player The player to check the amount for
-	 * @param limitGroup The group to check
-	 * @param buyRegions All the regions a player has bought
-	 * @return The number of regions that the player has bought matching the limit group (worlds and groups filters)
-	 */
-	public int hasBuyRegionsInLimitGroup(Player player, String limitGroup, List<BuyRegion> buyRegions) {
-		int result = 0;
-		for(BuyRegion region : buyRegions) {
-			if(region.isBuyer(player)) {
-				if(region.matchesLimitGroup(limitGroup)) {
-					result++;
-				}
-			}
-		}
-		return result;
-	}
-	
-	/**
-	 * Get the amount of rent regions a player has matching a certain limits group (config.yml > limitGroups)
-	 * @param player The player to check the amount for
-	 * @param limitGroup The group to check
-	 * @param rentRegions All the regions a player has bought
-	 * @return The number of regions that the player has rented matching the limit group (worlds and groups filters)
-	 */
-	public int hasRentRegionsInLimitGroup(Player player, String limitGroup, List<RentRegion> rentRegions) {
-		int result = 0;
-		for(RentRegion region : rentRegions) {
-			if(region.isRenter(player)) {
-				if(region.matchesLimitGroup(limitGroup)) {
-					result++;
-				}
-			}
-		}
-		return result;
-	}
-	
 	/**
 	 * Get the amount of regions a player has matching a certain limits group (config.yml > limitGroups)
 	 * @param player The player to check the amount for
@@ -2024,13 +1930,11 @@ public abstract class GeneralRegion implements GeneralRegionInterface {
 	 * @param buyRegions All the regions a player has bought or rented
 	 * @return The number of regions that the player has bought or rented matching the limit group (worlds and groups filters)
 	 */
-	public int hasRegionsInLimitGroup(Player player, String limitGroup, List<GeneralRegion> regions) {
+	public int hasRegionsInLimitGroup(Player player, String limitGroup, List<? extends GeneralRegion> regions, GeneralRegion exclude) {
 		int result = 0;
 		for(GeneralRegion region : regions) {
-			if(region.isOwner(player)) {
+			if(region.isOwner(player) && region.matchesLimitGroup(limitGroup) && (exclude == null || !exclude.getName().equals(region.getName()))) {
-				if(region.matchesLimitGroup(limitGroup)) {
+				result++;
-					result++;
-				}
 			}
 		}
 		return result;

AreaShop/src/main/java/nl/evolutioncoding/areashop/regions/RentRegion.java

@@ -426,9 +426,16 @@ public class RentRegion extends GeneralRegion {
 					plugin.message(player, "rent-restrictedToWorld", getWorldName(), player.getWorld().getName());
 					return false;
 				}				
-				// Check region limits if this is not extending				
+				// Check region limits if this is not extending
-				if(!extend) {
+				AreaShop.debug("extend="+extend+", config thing="+config.getBoolean("allowRegionExtendsWhenAboveLimits"));
-					LimitResult limitResult = this.limitsAllowRenting(player);
+				if(!(extend && config.getBoolean("allowRegionExtendsWhenAboveLimits"))) {
+					
+					LimitResult limitResult = null;
+					if(extend) {
+						limitResult = this.limitsAllow(RegionType.RENT, player, extend);
+					} else {
+						limitResult = this.limitsAllow(RegionType.RENT, player);
+					}
 					AreaShop.debug("LimitResult: " + limitResult.toString());
 					if(!limitResult.actionAllowed()) {
 						if(limitResult.getLimitingFactor() == LimitType.TOTAL) {
@@ -439,7 +446,10 @@ public class RentRegion extends GeneralRegion {
 							plugin.message(player, "rent-maximum", limitResult.getMaximum(), limitResult.getCurrent(), limitResult.getLimitingGroup());
 							return false;
 						}
-						// Should not be reached, but is safe like this
+						if(limitResult.getLimitingFactor() == LimitType.EXTEND) {
+							plugin.message(player, "rent-maximumExtend", limitResult.getMaximum(), limitResult.getCurrent()+1, limitResult.getLimitingGroup());
+							return false;
+						}
 						return false;
 					}
 				}

AreaShop/src/main/resources/config.yml

@@ -53,6 +53,9 @@ hours: [h, hour, hours, uur, uren]
 days: [d, day, days, dag, dagen]
 months: [M,  month,  months, maanden, maand]
 years: [y, year, years, jaar, jaren]
+## Allow or disallow extending rental region when the player is above his limits enforced by the 'limitGroups' below.
+## false will ensure a player will eventually lose his region when he has no access anymore (rankup with other limits for example)
+allowRegionExtendsWhenAboveLimits: false
 
 
 # ┌────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐