Merge pull request #194 from Civcraft/targetted_logging

Addressing some less then great logspamming due to what gets logged

Author: ProgrammerDan

.editorconfig

@@ -0,0 +1,20 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.java]
+indent_style = tab
+tab_width = 4
+trim_trailing_whitespace = true
+
+[*.xml]
+indent_style = tab
+tab_width = 4
+trim_trailing_whitespace = true
+
+[*.yml]
+indent_style = space
+tab_width = 2
+trim_trailing_whitespace = true

config.yml

@@ -13,10 +13,19 @@
 #  speed: the speed of the particles
 #  particleCount: the amount of particle to display. 
 #  view_distance: the distance from which players will be able to see the effect. default is 16. 
+# internal_logging logs Citadel internal status messages, config notices, and the like. Strongly recommend it be on.
 internal_logging: true
+# command_logging logs the _response_ that Citadel sends to the player; very useful.
 command_logging: true
-break_logging: true
+# break_logging logs all reinforcement breaks that are done in /ctb mode (e.g. friendly breaks).
+break_logging: false
+# hostile_logging logs all reinforcement breaks that are done without bypass (e.g. hostile breaks).
+hostile_logging: true
+# damage_logging logs all reinforcement break attempts. Leave off unless you need it.
+damage_logging: false
+# reinf_logging logs all reinforcement creation and also logs when group lookups fail. Can get super spammy.
 reinf_logging: false
+# All logging states can be controlled using /ctsl
 reinforcements:
  stone_tier:
   material: STONE

pom.xml

@@ -5,7 +5,7 @@
 	<groupId>vg.civcraft.mc.citadel</groupId>
 	<artifactId>Citadel</artifactId>
 	<packaging>jar</packaging>
-	<version>3.5.7</version>
+	<version>3.5.8</version>
 	<name>Citadel</name>
 	<url>https://github.com/Civcraft/Citadel</url>
 

src/vg/civcraft/mc/citadel/CitadelConfigManager.java

@@ -182,10 +182,18 @@ public static boolean shouldLogPlayerCommands() {
 		return config.getBoolean("command_logging", false);
 	}
 
-	public static boolean shouldLogBreaks() {
+	public static boolean shouldLogFriendlyBreaks() {
 		return config.getBoolean("break_logging", false);
 	}
 
+	public static boolean shouldLogHostileBreaks() {
+		return config.getBoolean("hostile_logging", false);
+	}
+
+	public static boolean shouldLogDamage() {
+		return config.getBoolean("damage_logging", false);
+	}
+
 	public static boolean shouldLogReinforcement() {
 		return config.getBoolean("reinf_logging", false);
 	}

src/vg/civcraft/mc/citadel/Utility.java

@@ -418,10 +418,22 @@ public static boolean reinforcementDamaged(Player player, Reinforcement reinforc
         reinforcement.setDurability(durability);
         boolean cancelled = durability > 0;
         if (durability <= 0) {
-            cancelled = reinforcementBroken(null, reinforcement);
+			if (CitadelConfigManager.shouldLogHostileBreaks()) {
+				StringBuffer slb = new StringBuffer();
+				if (player != null) {
+					slb.append("Player ").append(player.getName()).append(" [").append(player.getUniqueId())
+								.append("] ");
+				} else {
+					slb.append("Something ");
+				}
+				slb.append("broke a ").append(reinforcement.getMaterial()).append(" reinforcement at ")
+						.append(reinforcement.getLocation());
+				Citadel.Log(slb.toString());
+			}
+	        cancelled = reinforcementBroken(null, reinforcement);
         } else {
 			/* TODO: Move to ReinforcementEvent listener*/
-			if (CitadelConfigManager.shouldLogBreaks()) {
+			if (CitadelConfigManager.shouldLogDamage()) {
 				StringBuffer slb = new StringBuffer();
 				if (player != null) {
 					slb.append("Player ").append(player.getName()).append(" [").append(player.getUniqueId())
@@ -456,6 +468,7 @@ public static boolean reinforcementDamaged(Player player, Reinforcement reinforc
 					slb.append("excellent (");
 				}
 				slb.append(durability).append(") at ").append(reinforcement.getLocation());
+				Citadel.Log(slb.toString());
 			}
             if (reinforcement instanceof PlayerReinforcement) {
                 // leave message
@@ -539,22 +552,19 @@ public static boolean reinforcementBroken(Player player, Reinforcement reinforce
 			return false;
 		}
     	StringBuffer slb = null;
-		if (CitadelConfigManager.shouldLogBreaks()) {
+		boolean logIt = CitadelConfigManager.shouldLogFriendlyBreaks() && player != null;
+		if (logIt) {
 			slb = new StringBuffer();
-			if (player != null) {
-				slb.append("Player ").append(player.getName()).append(" [").append(player.getUniqueId())
-						.append("]");
-			} else {
-				slb.append("Something ");
-			}
-			slb.append("broke a ").append(reinforcement.getMaterial()).append(" reinforcement at ")
+			slb.append("Player ").append(player.getName()).append(" [").append(player.getUniqueId())
+					.append("] bypassed a ").append(reinforcement.getMaterial()).append(" reinforcement at ")
 					.append(reinforcement.getLocation());
 		}
         Citadel.getReinforcementManager().deleteReinforcement(reinforcement);
         if (reinforcement instanceof PlayerReinforcement) {
             PlayerReinforcement pr = (PlayerReinforcement)reinforcement;
             ReinforcementType material = ReinforcementType.getReinforcementType(pr.getStackRepresentation());
-            if (rng.nextDouble() <= pr.getHealth() * material.getPercentReturn()) {
+			// RNG is [0,1) so <= would give chance of return if health is 0. Replaced with < alone to fix.
+            if (rng.nextDouble() < pr.getHealth() * material.getPercentReturn()) {
                 Location location = pr.getLocation();
                 if (player != null){
                     Inventory inv = player.getInventory();
@@ -579,17 +589,17 @@ public static boolean reinforcementBroken(Player player, Reinforcement reinforce
                 	dropItemAtLocation(location, new ItemStack(material.getMaterial()
                             , material.getReturnValue()));
 				}
-                if (CitadelConfigManager.shouldLogBreaks()) {
+				if (logIt) {
                     slb.append(" - reinf mat refunded");
 					Citadel.Log(slb.toString());
                 }
-            } else if (CitadelConfigManager.shouldLogBreaks()) { 
+            } else if (logIt) {
                 slb.append(" - reinf mat lost");
 				Citadel.Log(slb.toString());
             }
             return (pr.isDoor() || pr.isContainer());
         }
-        if (CitadelConfigManager.shouldLogBreaks()) {
+        if (logIt) {
             Citadel.Log(slb.toString());
         }
         return false;  // implicit isSecureable() == false

src/vg/civcraft/mc/citadel/command/commands/Acid.java

@@ -109,7 +109,7 @@ public boolean execute(CommandSender sender, String[] args) {
 				return true;
 			}
 
-			if (CitadelConfigManager.shouldLogBreaks()) {
+			if (CitadelConfigManager.shouldLogHostileBreaks()) {
 				Citadel.getInstance().getLogger().log(Level.INFO, "Acid at {0} broke {1} at {2}",
 						new Object[] {block.getLocation(), topFace.getType(), topFace.getLocation()});
 			}

src/vg/civcraft/mc/citadel/command/commands/SetLogging.java

@@ -17,7 +17,7 @@ public SetLogging(String name) {
 		super(name);
 		setIdentifier("ctsl");
 		setDescription("Allows admins to toggle special logging types live or show current status");
-		setUsage("/ctsl [internal|playercommands|breaks|reinforcements [on|off]]");
+		setUsage("/ctsl [internal|playercommands|breaks|hostilebreaks|damage|reinforcements [on|off]]");
 		setArguments(0, 2);
 	}
 
@@ -43,7 +43,9 @@ public boolean execute(CommandSender sender, String[] args) {
 			StringBuilder sb = new StringBuilder("Current deep logging set to: \n");
 			sb.append("   Internal: ").append(CitadelConfigManager.shouldLogInternal()).append("\n");
 			sb.append("   Player Command Responses: ").append(CitadelConfigManager.shouldLogPlayerCommands()).append("\n");
-			sb.append("   Breaks: ").append(CitadelConfigManager.shouldLogBreaks()).append("\n");
+			sb.append("   Friendly/CTB Breaks: ").append(CitadelConfigManager.shouldLogFriendlyBreaks()).append("\n");
+			sb.append("   Hostile Breaks: ").append(CitadelConfigManager.shouldLogHostileBreaks()).append("\n");
+			sb.append("   Damage: ").append(CitadelConfigManager.shouldLogDamage()).append("\n");
 			sb.append("   Reinforcements: ").append(CitadelConfigManager.shouldLogReinforcement()).append("\n");
 
 			sendAndLog(sender, ChatColor.GREEN, sb.toString());
@@ -54,13 +56,19 @@ public boolean execute(CommandSender sender, String[] args) {
 		if (args.length >= 1) {
 			if ("internal".equalsIgnoreCase(args[0])) {
 				flag = "internal_logging";
-				newval = CitadelConfigManager.shouldLogInternal();				
+				newval = CitadelConfigManager.shouldLogInternal();
 			} else if ("playercommands".equalsIgnoreCase(args[0])) {
 				flag = "command_logging";
-				newval = CitadelConfigManager.shouldLogPlayerCommands();				
+				newval = CitadelConfigManager.shouldLogPlayerCommands();
 			} else if ("breaks".equalsIgnoreCase(args[0])) {
 				flag = "break_logging";
-				newval = CitadelConfigManager.shouldLogBreaks();
+				newval = CitadelConfigManager.shouldLogFriendlyBreaks();
+			} else if ("hostilebreaks".equalsIgnoreCase(args[0])) {
+				flag = "hostile_logging";
+				newval = CitadelConfigManager.shouldLogHostileBreaks();
+			} else if ("damage".equalsIgnoreCase(args[0])) {
+				flag = "damage_logging";
+				newval = CitadelConfigManager.shouldLogDamage();
 			} else if ("reinforcements".equalsIgnoreCase(args[0])) {
 				flag = "reinf_logging";
 				newval = CitadelConfigManager.shouldLogReinforcement();				
@@ -76,15 +84,15 @@ public boolean execute(CommandSender sender, String[] args) {
 
 		if (flag != null) {
 			Citadel.getInstance().getConfig().set(flag, newval);
-			sendAndLog(sender, ChatColor.GREEN, "Flag " + newval + " is " + (newval ? "on" : "off"));
+			sendAndLog(sender, ChatColor.GREEN, "Flag " + flag + " is " + (newval ? "on" : "off"));
 			return true;
 		} else {
 			sendAndLog(sender, ChatColor.RED, "Unknown setting!");
 			return false;
 		}
 	}
 
-	private static List<String> cmds = Arrays.asList("internal","playercommands", "breaks", "reinforcements");
+	private static List<String> cmds = Arrays.asList("internal","playercommands", "hostilebreaks", "breaks", "damage", "reinforcements");
 	private static List<String> flgs = Arrays.asList("on", "off");
 	@Override
 	public List<String> tabComplete(CommandSender arg0, String[] arg1) {