Refactored and fixed fire handling.

- Logic should now be easier to follow
- Less code duplication
- The fire-spread flag, the fire.disable-all-fire-spread and the
  stop/allowfire commands now do the same thing.
- The "High frequency flag" setting is now enforced consistently on all
  parts of the fire-spread flag, not just half of it.

pom.xml

@@ -2,7 +2,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.sk89q</groupId>
   <artifactId>worldguard</artifactId>
-  <version>5.9</version>
+  <version>5.9.1-SNAPSHOT</version>
   <packaging>jar</packaging>
   
   <!-- Project information -->
@@ -31,7 +31,7 @@
     <connection>scm:git:git://github.com/sk89q/worldguard.git</connection>
     <developerConnection>scm:git:git@github.com:sk89q/worldguard.git</developerConnection>
     <url>https://github.com/sk89q/worldguard</url>
-    <tag>5.9</tag>
+    <tag>master</tag>
   </scm>
   
   <mailingLists>

src/main/java/com/sk89q/worldguard/bukkit/WorldGuardBlockListener.java

@@ -39,7 +39,6 @@ import org.bukkit.event.block.BlockFadeEvent;
 import org.bukkit.event.block.BlockFormEvent;
 import org.bukkit.event.block.BlockFromToEvent;
 import org.bukkit.event.block.BlockIgniteEvent;
-import org.bukkit.event.block.BlockIgniteEvent.IgniteCause;
 import org.bukkit.event.block.BlockPhysicsEvent;
 import org.bukkit.event.block.BlockPistonExtendEvent;
 import org.bukkit.event.block.BlockPistonRetractEvent;
@@ -272,55 +271,80 @@ public class WorldGuardBlockListener implements Listener {
         }
     }
 
+    /**
+     * Determines whether fire can spread into a block.
+     *
+     * @param block The block in question
+     * @return true if allowed, false otherwise
+     */
+    private boolean isFireSpreadAllowed(Block block) {
+        final ConfigurationManager cfg = plugin.getGlobalStateManager();
+        final WorldConfiguration wcfg = cfg.get(block.getWorld());
+
+        if (wcfg.disableFireSpread) {
+            return false;
+        }
+
+        if (wcfg.fireSpreadDisableToggle) {
+            return false;
+        }
+
+        if (!wcfg.highFreqFlags) {
+            return true;
+        }
+
+        if (!wcfg.useRegions) {
+            return true;
+        }
+
+        final Vector pt = toVector(block);
+        final RegionManager mgr = plugin.getGlobalRegionManager().get(block.getWorld());
+        final ApplicableRegionSet set = mgr.getApplicableRegions(pt);
+
+        return set.allows(DefaultFlag.FIRE_SPREAD);
+
+    }
+
     /*
      * Called when a block gets ignited.
      */
     @EventHandler(priority = EventPriority.HIGH, ignoreCancelled = true)
     public void onBlockIgnite(BlockIgniteEvent event) {
-        IgniteCause cause = event.getCause();
-        Block block = event.getBlock();
-        World world = block.getWorld();
+        final Block block = event.getBlock();
+        final World world = block.getWorld();
 
-        ConfigurationManager cfg = plugin.getGlobalStateManager();
-        WorldConfiguration wcfg = cfg.get(world);
+        final ConfigurationManager cfg = plugin.getGlobalStateManager();
+        final WorldConfiguration wcfg = cfg.get(world);
 
         if (cfg.activityHaltToggle) {
             event.setCancelled(true);
             return;
         }
-        boolean isFireSpread = cause == IgniteCause.SPREAD;
 
-        if (wcfg.preventLightningFire && cause == IgniteCause.LIGHTNING) {
-            event.setCancelled(true);
-            return;
+        final ApplicableRegionSet set;
+
+        if (wcfg.useRegions) {
+            Vector pt = toVector(block);
+            RegionManager mgr = plugin.getGlobalRegionManager().get(world);
+            set = mgr.getApplicableRegions(pt);
+        } else {
+            set = null;
         }
 
-        if (wcfg.preventLavaFire && cause == IgniteCause.LAVA) {
-            event.setCancelled(true);
-            return;
-        }
+        switch (event.getCause()) {
+        case SPREAD:
+            if (!isFireSpreadAllowed(block)) {
+                event.setCancelled(true);
+                return;
+            }
 
-        if (wcfg.disableFireSpread && isFireSpread) {
-            event.setCancelled(true);
-            return;
-        }
+            if (wcfg.disableFireSpreadBlocks.size() <= 0) {
+                break;
+            }
 
-        if (wcfg.blockLighter && (cause == IgniteCause.FLINT_AND_STEEL || cause == IgniteCause.FIREBALL)
-                && event.getPlayer() != null
-                && !plugin.hasPermission(event.getPlayer(), "worldguard.override.lighter")) {
-            event.setCancelled(true);
-            return;
-        }
-
-        if (wcfg.fireSpreadDisableToggle && isFireSpread) {
-            event.setCancelled(true);
-            return;
-        }
-
-        if (wcfg.disableFireSpreadBlocks.size() > 0 && isFireSpread) {
-            int x = block.getX();
-            int y = block.getY();
-            int z = block.getZ();
+            final int x = block.getX();
+            final int y = block.getY();
+            final int z = block.getZ();
 
             if (wcfg.disableFireSpreadBlocks.contains(world.getBlockTypeIdAt(x, y - 1, z))
                     || wcfg.disableFireSpreadBlocks.contains(world.getBlockTypeIdAt(x + 1, y, z))
@@ -330,53 +354,92 @@ public class WorldGuardBlockListener implements Listener {
                 event.setCancelled(true);
                 return;
             }
-        }
 
-        if (wcfg.useRegions) {
-            Vector pt = toVector(block);
-            Player player = event.getPlayer();
-            RegionManager mgr = plugin.getGlobalRegionManager().get(world);
-            ApplicableRegionSet set = mgr.getApplicableRegions(pt);
+            break;
 
-            if (player != null && !plugin.getGlobalRegionManager().hasBypass(player, world)) {
-                LocalPlayer localPlayer = plugin.wrapPlayer(player);
-
-                // this is preliminarily handled in the player listener under handleBlockRightClick
-                // why it's handled here too, no one knows
-                if (cause == IgniteCause.FLINT_AND_STEEL || cause == IgniteCause.FIREBALL) {
-                    if (!set.allows(DefaultFlag.LIGHTER)
-                            && !set.canBuild(localPlayer)
-                            && !plugin.hasPermission(player, "worldguard.override.lighter")) {
-                        event.setCancelled(true);
-                        return;
-                    }
-                }
-            }
-
-            if (wcfg.highFreqFlags && isFireSpread
-                    && !set.allows(DefaultFlag.FIRE_SPREAD)) {
+        case LIGHTNING:
+            if (wcfg.preventLightningFire) {
                 event.setCancelled(true);
                 return;
             }
 
-            if (wcfg.highFreqFlags && cause == IgniteCause.LAVA
-                    && !set.allows(DefaultFlag.LAVA_FIRE)) {
+            if (!wcfg.useRegions) {
+                break;
+            }
+
+            if (set.allows(DefaultFlag.LIGHTNING)) {
+                break;
+            }
+
+            event.setCancelled(true);
+            return;
+
+        case LAVA:
+            if (wcfg.preventLavaFire) {
                 event.setCancelled(true);
                 return;
             }
 
-            if (cause == IgniteCause.FIREBALL && event.getPlayer() == null) {
-                // wtf bukkit, FIREBALL is supposed to be reserved to players
-                if (!set.allows(DefaultFlag.GHAST_FIREBALL)) {
-                    event.setCancelled(true);
-                    return;
-                }
+            if (!wcfg.useRegions) {
+                break;
             }
 
-            if (cause == IgniteCause.LIGHTNING && !set.allows(DefaultFlag.LIGHTNING)) {
+            if (!wcfg.highFreqFlags) {
+                break;
+            }
+
+            if (set.allows(DefaultFlag.LAVA_FIRE)) {
+                break;
+            }
+
+            event.setCancelled(true);
+            return;
+
+        case FIREBALL:
+            if (wcfg.useRegions && event.getPlayer() == null && !set.allows(DefaultFlag.GHAST_FIREBALL)) {
                 event.setCancelled(true);
                 return;
             }
+
+            /* FALL-THROUGH */
+
+        case FLINT_AND_STEEL:
+            final Player player = event.getPlayer();
+            if (player == null) {
+                break;
+            }
+
+            if (wcfg.blockLighter && !plugin.hasPermission(player, "worldguard.override.lighter")) {
+                event.setCancelled(true);
+                return;
+            }
+
+            if (!wcfg.useRegions) {
+                break;
+            }
+
+            if (plugin.getGlobalRegionManager().hasBypass(player, world)) {
+                break;
+            }
+
+            final LocalPlayer localPlayer = plugin.wrapPlayer(player);
+
+            // Lighters are preliminarily handled in the player listener under handleBlockRightClick.
+            // Why they're handled here too, no one knows
+            if (set.allows(DefaultFlag.LIGHTER)) {
+                break;
+            }
+
+            if (set.canBuild(localPlayer)) {
+                break;
+            }
+
+            if (plugin.hasPermission(player, "worldguard.override.lighter")) {
+                break;
+            }
+
+            event.setCancelled(true);
+            return;
         }
     }
 
@@ -385,32 +448,19 @@ public class WorldGuardBlockListener implements Listener {
      */
     @EventHandler(priority = EventPriority.HIGH, ignoreCancelled = true)
     public void onBlockBurn(BlockBurnEvent event) {
-        ConfigurationManager cfg = plugin.getGlobalStateManager();
-        WorldConfiguration wcfg = cfg.get(event.getBlock().getWorld());
+        final ConfigurationManager cfg = plugin.getGlobalStateManager();
+        final WorldConfiguration wcfg = cfg.get(event.getBlock().getWorld());
 
         if (cfg.activityHaltToggle) {
             event.setCancelled(true);
             return;
         }
 
-        if (wcfg.disableFireSpread) {
-            event.setCancelled(true);
-            return;
-        }
-
-        if (wcfg.fireSpreadDisableToggle) {
-            Block block = event.getBlock();
-            event.setCancelled(true);
-            checkAndDestroyAround(block.getWorld(), block.getX(), block.getY(), block.getZ(), BlockID.FIRE);
-            return;
-        }
-
         if (wcfg.disableFireSpreadBlocks.size() > 0) {
-            Block block = event.getBlock();
+            final Block block = event.getBlock();
 
             if (wcfg.disableFireSpreadBlocks.contains(block.getTypeId())) {
                 event.setCancelled(true);
-                checkAndDestroyAround(block.getWorld(), block.getX(), block.getY(), block.getZ(), BlockID.FIRE);
                 return;
             }
         }
@@ -420,36 +470,9 @@ public class WorldGuardBlockListener implements Listener {
             return;
         }
 
-        if (wcfg.useRegions) {
-            Block block = event.getBlock();
-            int x = block.getX();
-            int y = block.getY();
-            int z = block.getZ();
-            Vector pt = toVector(block);
-            RegionManager mgr = plugin.getGlobalRegionManager().get(block.getWorld());
-            ApplicableRegionSet set = mgr.getApplicableRegions(pt);
-
-            if (!set.allows(DefaultFlag.FIRE_SPREAD)) {
-                checkAndDestroyAround(block.getWorld(), x, y, z, BlockID.FIRE);
-                event.setCancelled(true);
-                return;
-            }
-
-        }
-    }
-
-    private void checkAndDestroyAround(World world, int x, int y, int z, int required) {
-        checkAndDestroy(world, x, y, z + 1, required);
-        checkAndDestroy(world, x, y, z - 1, required);
-        checkAndDestroy(world, x, y + 1, z, required);
-        checkAndDestroy(world, x, y - 1, z, required);
-        checkAndDestroy(world, x + 1, y, z, required);
-        checkAndDestroy(world, x - 1, y, z, required);
-    }
-
-    private void checkAndDestroy(World world, int x, int y, int z, int required) {
-        if (world.getBlockTypeIdAt(x, y, z) == required) {
-            world.getBlockAt(x, y, z).setTypeId(BlockID.AIR);
+        if (!isFireSpreadAllowed(event.getBlock())) {
+            event.setCancelled(true);
+            return;
         }
     }
 
@@ -832,6 +855,18 @@ public class WorldGuardBlockListener implements Listener {
             }
             break;
 
+        case BlockID.FIRE:
+            if (event.getNewState().getTypeId() != BlockID.AIR) {
+                return;
+            }
+
+            if (wcfg.useRegions && !plugin.getGlobalRegionManager().allows(
+                    DefaultFlag.FIRE_EXTINGUISH, event.getBlock().getLocation())) {
+                event.setCancelled(true);
+                return;
+            }
+            break;
+
         case BlockID.SOIL:
             if (wcfg.disableSoilDehydration) {
                 event.setCancelled(true);

src/main/java/com/sk89q/worldguard/bukkit/WorldGuardEntityListener.java

@@ -70,6 +70,7 @@ import org.bukkit.event.entity.PlayerDeathEvent;
 import org.bukkit.event.entity.PotionSplashEvent;
 import org.bukkit.inventory.ItemStack;
 import org.bukkit.potion.PotionEffect;
+import org.bukkit.projectiles.ProjectileSource;
 
 import com.sk89q.worldedit.Vector;
 import com.sk89q.worldedit.blocks.BlockID;
@@ -330,7 +331,7 @@ public class WorldGuardEntityListener implements Listener {
                         RegionManager mgr = plugin.getGlobalRegionManager().get(player.getWorld());
                         ApplicableRegionSet set = mgr.getApplicableRegions(pt);
                         if (fireball.getShooter() instanceof Player) {
-                            Vector pt2 = toVector(fireball.getShooter().getLocation());
+                            Vector pt2 = toVector(((Player) fireball.getShooter()).getLocation());
                             if (!mgr.getApplicableRegions(pt2).allows(DefaultFlag.PVP, plugin.wrapPlayer((Player) fireball.getShooter()))) {
                                 tryCancelPVPEvent((Player) fireball.getShooter(), player, event, true);
                             } else if (!set.allows(DefaultFlag.PVP, localPlayer)) {
@@ -399,7 +400,13 @@ public class WorldGuardEntityListener implements Listener {
 
     private void onEntityDamageByProjectile(EntityDamageByEntityEvent event) {
         Entity defender = event.getEntity();
-        Entity attacker = ((Projectile) event.getDamager()).getShooter();
+        Entity attacker;
+        ProjectileSource source = ((Projectile) event.getDamager()).getShooter();
+        if (source instanceof LivingEntity) {
+            attacker = (LivingEntity) source;
+        } else {
+            return;
+        }
 
         if (defender instanceof Player) {
             Player player = (Player) defender;

src/main/java/com/sk89q/worldguard/bukkit/WorldGuardHangingListener.java

@@ -28,6 +28,7 @@ import org.bukkit.entity.Creeper;
 import org.bukkit.entity.Entity;
 import org.bukkit.entity.Hanging;
 import org.bukkit.entity.ItemFrame;
+import org.bukkit.entity.LivingEntity;
 import org.bukkit.entity.Painting;
 import org.bukkit.entity.Player;
 import org.bukkit.entity.Projectile;
@@ -39,6 +40,7 @@ import org.bukkit.event.hanging.HangingBreakEvent;
 import org.bukkit.event.hanging.HangingBreakEvent.RemoveCause;
 import org.bukkit.event.hanging.HangingPlaceEvent;
 import org.bukkit.event.player.PlayerInteractEntityEvent;
+import org.bukkit.projectiles.ProjectileSource;
 
 import com.sk89q.worldedit.blocks.ItemID;
 import com.sk89q.worldguard.blacklist.events.BlockBreakBlacklistEvent;
@@ -81,8 +83,9 @@ public class WorldGuardHangingListener implements Listener {
             HangingBreakByEntityEvent entityEvent = (HangingBreakByEntityEvent) event;
             Entity removerEntity = entityEvent.getRemover();
             if (removerEntity instanceof Projectile) {
-                Projectile projectile = (Projectile) removerEntity; 
-                removerEntity = projectile.getShooter() != null ? projectile.getShooter() : removerEntity; 
+                Projectile projectile = (Projectile) removerEntity;
+                ProjectileSource remover = projectile.getShooter(); 
+                removerEntity = (remover instanceof LivingEntity ? (LivingEntity) remover : null);
             }
 
             if (removerEntity instanceof Player) {
@@ -123,6 +126,8 @@ public class WorldGuardHangingListener implements Listener {
                     }
                 }
 
+                // this now covers dispensers as well, if removerEntity is null above,
+                // due to a non-LivingEntity ProjectileSource
                 if (hanging instanceof Painting
                         && (wcfg.blockEntityPaintingDestroy
                         || (wcfg.useRegions

src/main/java/com/sk89q/worldguard/protection/flags/DefaultFlag.java

@@ -42,6 +42,7 @@ public final class DefaultFlag {
     public static final StateFlag TNT = new StateFlag("tnt", true, RegionGroup.ALL);
     public static final StateFlag LIGHTER = new StateFlag("lighter", true);
     public static final StateFlag FIRE_SPREAD = new StateFlag("fire-spread", true);
+    public static final StateFlag FIRE_EXTINGUISH = new StateFlag("fire-extinguish", true);
     public static final StateFlag LAVA_FIRE = new StateFlag("lava-fire", true);
     public static final StateFlag LIGHTNING = new StateFlag("lightning", true);
     public static final StateFlag CHEST_ACCESS = new StateFlag("chest-access", false);
@@ -109,7 +110,7 @@ public final class DefaultFlag {
         FEED_DELAY, FEED_AMOUNT, MIN_FOOD, MAX_FOOD,
         SNOW_FALL, SNOW_MELT, ICE_FORM, ICE_MELT, SOIL_DRY, GAME_MODE,
         MUSHROOMS, LEAF_DECAY, GRASS_SPREAD, MYCELIUM_SPREAD, VINE_GROWTH,
-        SEND_CHAT, RECEIVE_CHAT, FIRE_SPREAD, LAVA_FIRE, LAVA_FLOW, WATER_FLOW,
+        SEND_CHAT, RECEIVE_CHAT, FIRE_SPREAD, FIRE_EXTINGUISH, LAVA_FIRE, LAVA_FLOW, WATER_FLOW,
         TELE_LOC, SPAWN_LOC, POTION_SPLASH,
         BLOCKED_CMDS, ALLOWED_CMDS, PRICE, BUYABLE, ENABLE_SHOP
     };