(Re)designed BlockSafety for extension.

src/main/java/com/onarandombox/MultiverseCore/MVWorld.java

@@ -7,6 +7,7 @@
 
 package com.onarandombox.MultiverseCore;
 
+import com.onarandombox.MultiverseCore.api.BlockSafety;
 import com.onarandombox.MultiverseCore.api.MultiverseWorld;
 import com.onarandombox.MultiverseCore.configuration.ConfigPropertyFactory;
 import com.onarandombox.MultiverseCore.configuration.MVActiveConfigProperty;
@@ -14,7 +15,6 @@ import com.onarandombox.MultiverseCore.configuration.MVConfigProperty;
 import com.onarandombox.MultiverseCore.enums.EnglishChatColor;
 import com.onarandombox.MultiverseCore.event.MVWorldPropertyChangeEvent;
 import com.onarandombox.MultiverseCore.exceptions.PropertyDoesNotExistException;
-import com.onarandombox.MultiverseCore.utils.BlockSafety;
 import com.onarandombox.MultiverseCore.utils.LocationManipulation;
 import com.onarandombox.MultiverseCore.utils.SafeTTeleporter;
 import org.bukkit.ChatColor;
@@ -953,7 +953,7 @@ public class MVWorld implements MultiverseWorld {
         // Set the worldspawn to our configspawn
         w.setSpawnLocation(configLocation.getBlockX(), configLocation.getBlockY(), configLocation.getBlockZ());
         SafeTTeleporter teleporter = this.plugin.getTeleporter();
-        BlockSafety bs = new BlockSafety();
+        BlockSafety bs = this.plugin.getBlockSafety();
         // Verify that location was safe
         if (!bs.playerCanSpawnHereSafely(configLocation)) {
             if (!this.getAdjustSpawn()) {

src/main/java/com/onarandombox/MultiverseCore/MultiverseCore.java

@@ -9,6 +9,7 @@ package com.onarandombox.MultiverseCore;
 
 import com.fernferret.allpay.AllPay;
 import com.fernferret.allpay.GenericBank;
+import com.onarandombox.MultiverseCore.api.BlockSafety;
 import com.onarandombox.MultiverseCore.api.Core;
 import com.onarandombox.MultiverseCore.api.MVPlugin;
 import com.onarandombox.MultiverseCore.api.MVWorldManager;
@@ -33,6 +34,7 @@ import com.onarandombox.MultiverseCore.utils.MVMessaging;
 import com.onarandombox.MultiverseCore.utils.MVPermissions;
 import com.onarandombox.MultiverseCore.utils.MVPlayerSession;
 import com.onarandombox.MultiverseCore.utils.SafeTTeleporter;
+import com.onarandombox.MultiverseCore.utils.SimpleBlockSafety;
 import com.onarandombox.MultiverseCore.utils.SpoutInterface;
 import com.onarandombox.MultiverseCore.utils.WorldManager;
 import com.pneumaticraft.commandhandler.CommandHandler;
@@ -175,6 +177,7 @@ public class MultiverseCore extends JavaPlugin implements MVPlugin, Core {
     private static final double ALLPAY_VERSION = 3;
     private static final double CH_VERSION = 4;
     private MVMessaging messaging;
+    private BlockSafety blockSafety;
 
     private File serverFolder = new File(System.getProperty("user.dir"));
 
@@ -184,6 +187,8 @@ public class MultiverseCore extends JavaPlugin implements MVPlugin, Core {
         getDataFolder().mkdirs();
         // Setup our Debug Log
         debugLog = new DebugLog("Multiverse-Core", getDataFolder() + File.separator + "debug.log");
+        // Setup our BlockSafety
+        this.blockSafety = new SimpleBlockSafety();
     }
 
     /**
@@ -840,4 +845,20 @@ public class MultiverseCore extends JavaPlugin implements MVPlugin, Core {
         return this.anchorManager;
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public BlockSafety getBlockSafety() {
+        return blockSafety;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public void setBlockSafety(BlockSafety bs) {
+        this.blockSafety = bs;
+    }
+
 }

src/main/java/com/onarandombox/MultiverseCore/api/BlockSafety.java

@@ -0,0 +1,72 @@
+package com.onarandombox.MultiverseCore.api;
+
+import org.bukkit.Location;
+import org.bukkit.World;
+import org.bukkit.entity.Minecart;
+import org.bukkit.entity.Vehicle;
+
+/**
+ * Used to get block/location-related information.
+ */
+public interface BlockSafety {
+    /**
+     * This function checks whether the block at the given coordinates are above air or not.
+     * @param l The {@link Location} of the block.
+     * @return True if the block at that {@link Location} is above air.
+     */
+    boolean isBlockAboveAir(Location l);
+
+    /**
+     * Checks if a player can spawn safely at the given coordinates.
+     * @param world The {@link World}.
+     * @param x The x-coordinate.
+     * @param y The y-coordinate.
+     * @param z The z-coordinate.
+     * @return True if a player can spawn safely at the given coordinates.
+     */
+    boolean playerCanSpawnHereSafely(World world, double x, double y, double z);
+
+    /**
+     * This function checks whether the block at the coordinates given is safe or not by checking for Lava/Fire/Air
+     * etc. This also ensures there is enough space for a player to spawn!
+     *
+     * @param l The {@link Location}
+     * @return Whether the player can spawn safely at the given {@link Location}
+     */
+    boolean playerCanSpawnHereSafely(Location l);
+
+    /**
+     * Gets the location of the top block at the specified {@link Location}.
+     * @param l Any {@link Location}.
+     * @return The {@link Location} of the top-block.
+     */
+    Location getTopBlock(Location l);
+
+    /**
+     * Gets the location of the top block at the specified {@link Location}.
+     * @param l Any {@link Location}.
+     * @return The {@link Location} of the top-block.
+     */
+    Location getBottomBlock(Location l);
+
+    /**
+     * Checks if an entity would be on track at the specified {@link Location}.
+     * @param l The {@link Location}.
+     * @return True if an entity would be on tracks at the specified {@link Location}.
+     */
+    boolean isEntitiyOnTrack(Location l);
+
+    /**
+     * Checks if the specified {@link Minecart} can spawn safely.
+     * @param cart The {@link Minecart}.
+     * @return True if the minecart can spawn safely.
+     */
+    boolean canSpawnCartSafely(Minecart cart);
+
+    /**
+     * Checks if the specified {@link Vehicle} can spawn safely.
+     * @param vehicle The {@link Vehicle}.
+     * @return True if the vehicle can spawn safely.
+     */
+    boolean canSpawnVehicleSafely(Vehicle vehicle);
+}

src/main/java/com/onarandombox/MultiverseCore/api/Core.java

@@ -163,4 +163,20 @@ public interface Core {
      * @return The readable authors-{@link String}
      */
     String getAuthors();
+
+    /**
+     * Gets the {@link BlockSafety} this {@link Core} is using.
+     * @return The {@link BlockSafety} this {@link Core} is using.
+     * @see BlockSafety
+     * @see SimpleBlockSafety
+     */
+    BlockSafety getBlockSafety();
+
+    /**
+     * Sets the {@link BlockSafety} this {@link Core} is using.
+     * @param blockSafety The new {@link BlockSafety}.
+     * @see BlockSafety
+     * @see SimpleBlockSafety
+     */
+    void setBlockSafety(BlockSafety blockSafety);
 }

src/main/java/com/onarandombox/MultiverseCore/commands/SetSpawnCommand.java

@@ -8,8 +8,8 @@
 package com.onarandombox.MultiverseCore.commands;
 
 import com.onarandombox.MultiverseCore.MultiverseCore;
+import com.onarandombox.MultiverseCore.api.BlockSafety;
 import com.onarandombox.MultiverseCore.api.MultiverseWorld;
-import com.onarandombox.MultiverseCore.utils.BlockSafety;
 import com.onarandombox.MultiverseCore.utils.LocationManipulation;
 import org.bukkit.ChatColor;
 import org.bukkit.Location;
@@ -56,7 +56,7 @@ public class SetSpawnCommand extends MultiverseCommand {
             MultiverseWorld foundWorld = this.plugin.getMVWorldManager().getMVWorld(w.getName());
             if (foundWorld != null) {
                 foundWorld.setSpawnLocation(p.getLocation());
-                BlockSafety bs = new BlockSafety();
+                BlockSafety bs = this.plugin.getBlockSafety();
                 if (!bs.playerCanSpawnHereSafely(p.getLocation()) && foundWorld.getAdjustSpawn()) {
                     sender.sendMessage("It looks like that location would normally be unsafe. But I trust you.");
                     sender.sendMessage("I'm turning off the Safe-T-Teleporter for spawns to this world.");

src/main/java/com/onarandombox/MultiverseCore/utils/BlockSafety.java

@@ -18,7 +18,10 @@ import java.util.logging.Level;
 
 /**
  * Used to determine block/location-related facts.
+ *
+ * @deprecated Use instead: {@link com.onarandombox.MultiverseCore.api.BlockSafety} and {@link SimpleBlockSafety}.
  */
+@Deprecated
 public class BlockSafety {
 
     /**

src/main/java/com/onarandombox/MultiverseCore/utils/SafeTTeleporter.java

@@ -8,9 +8,11 @@
 package com.onarandombox.MultiverseCore.utils;
 
 import com.onarandombox.MultiverseCore.MultiverseCore;
+import com.onarandombox.MultiverseCore.api.BlockSafety;
 import com.onarandombox.MultiverseCore.api.MVDestination;
 import com.onarandombox.MultiverseCore.destination.InvalidDestination;
 import com.onarandombox.MultiverseCore.enums.TeleportResult;
+
 import org.bukkit.Location;
 import org.bukkit.Material;
 import org.bukkit.block.Block;
@@ -34,7 +36,7 @@ public class SafeTTeleporter {
 
     public SafeTTeleporter(MultiverseCore plugin) {
         this.plugin = plugin;
-        this.bs = new BlockSafety();
+        this.bs = plugin.getBlockSafety();
     }
 
     private static final int DEFAULT_TOLERANCE = 6;

src/main/java/com/onarandombox/MultiverseCore/utils/SimpleBlockSafety.java

@@ -0,0 +1,248 @@
+/******************************************************************************
+ * Multiverse 2 Copyright (c) the Multiverse Team 2011.                       *
+ * Multiverse 2 is licensed under the BSD License.                            *
+ * For more information please check the README.md file included              *
+ * with this project.                                                         *
+ ******************************************************************************/
+
+package com.onarandombox.MultiverseCore.utils;
+
+import com.onarandombox.MultiverseCore.MultiverseCore;
+import com.onarandombox.MultiverseCore.api.BlockSafety;
+
+import org.bukkit.Location;
+import org.bukkit.Material;
+import org.bukkit.World;
+import org.bukkit.entity.Minecart;
+import org.bukkit.entity.Vehicle;
+
+import java.util.logging.Level;
+
+/**
+ * The default-implementation of {@link BlockSafety}.
+ */
+public class SimpleBlockSafety implements BlockSafety {
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public boolean isBlockAboveAir(Location l) {
+        Location downOne = l.clone();
+        downOne.setY(downOne.getY() - 1);
+        return (downOne.getBlock().getType() == Material.AIR);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public boolean playerCanSpawnHereSafely(World world, double x, double y, double z) {
+        Location l = new Location(world, x, y, z);
+        return playerCanSpawnHereSafely(l);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public boolean playerCanSpawnHereSafely(Location l) {
+        if (l == null) {
+            // Can't safely spawn at a null location!
+            return false;
+        }
+
+        World world = l.getWorld();
+        Location actual = l.clone();
+        Location upOne = l.clone();
+        Location downOne = l.clone();
+        upOne.setY(upOne.getY() + 1);
+        downOne.setY(downOne.getY() - 1);
+
+        if (this.isSolidBlock(world.getBlockAt(actual).getType())
+                || this.isSolidBlock(upOne.getBlock().getType())) {
+            MultiverseCore.staticLog(Level.FINER, "Error Here (Actual)? ("
+                + actual.getBlock().getType() + ")[" + this.isSolidBlock(actual.getBlock().getType()) + "]");
+            MultiverseCore.staticLog(Level.FINER, "Error Here (upOne)? ("
+                + upOne.getBlock().getType() + ")[" + this.isSolidBlock(upOne.getBlock().getType()) + "]");
+            return false;
+        }
+
+        if (downOne.getBlock().getType() == Material.LAVA || downOne.getBlock().getType() == Material.STATIONARY_LAVA) {
+            MultiverseCore.staticLog(Level.FINER, "Error Here (downOne)? ("
+                + downOne.getBlock().getType() + ")[" + this.isSolidBlock(downOne.getBlock().getType()) + "]");
+            return false;
+        }
+
+        if (downOne.getBlock().getType() == Material.FIRE) {
+            MultiverseCore.staticLog(Level.FINER, "There's fire below! ("
+                + actual.getBlock().getType() + ")[" + this.isSolidBlock(actual.getBlock().getType()) + "]");
+            return false;
+        }
+
+        if (isBlockAboveAir(actual)) {
+            MultiverseCore.staticLog(Level.FINER, "Is block above air [" + isBlockAboveAir(actual) + "]");
+            MultiverseCore.staticLog(Level.FINER, "Has 2 blocks of water below [" + this.hasTwoBlocksofWaterBelow(actual) + "]");
+            return this.hasTwoBlocksofWaterBelow(actual);
+        }
+        return true;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public Location getTopBlock(Location l) {
+        Location check = l.clone();
+        check.setY(127); // SUPPRESS CHECKSTYLE: MagicNumberCheck
+        while (check.getY() > 0) {
+            if (this.playerCanSpawnHereSafely(check)) {
+                return check;
+            }
+            check.setY(check.getY() - 1);
+        }
+        return null;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public Location getBottomBlock(Location l) {
+        Location check = l.clone();
+        check.setY(0);
+        while (check.getY() < 127) { // SUPPRESS CHECKSTYLE: MagicNumberCheck
+            if (this.playerCanSpawnHereSafely(check)) {
+                return check;
+            }
+            check.setY(check.getY() + 1);
+        }
+        return null;
+    }
+
+    /*
+     * If someone has a better way of this... Please either tell us, or submit a pull request!
+     */
+    private boolean isSolidBlock(Material type) {
+        switch (type) {
+            case AIR:
+                return false;
+            case SNOW:
+                return false;
+            case TRAP_DOOR:
+                return false;
+            case TORCH:
+                return false;
+            case YELLOW_FLOWER:
+                return false;
+            case RED_ROSE:
+                return false;
+            case RED_MUSHROOM:
+                return false;
+            case BROWN_MUSHROOM:
+                return false;
+            case REDSTONE:
+                return false;
+            case REDSTONE_WIRE:
+                return false;
+            case RAILS:
+                return false;
+            case POWERED_RAIL:
+                return false;
+            case REDSTONE_TORCH_ON:
+                return false;
+            case REDSTONE_TORCH_OFF:
+                return false;
+            case DEAD_BUSH:
+                return false;
+            case SAPLING:
+                return false;
+            case STONE_BUTTON:
+                return false;
+            case LEVER:
+                return false;
+            case LONG_GRASS:
+                return false;
+            case PORTAL:
+                return false;
+            case STONE_PLATE:
+                return false;
+            case WOOD_PLATE:
+                return false;
+            case SEEDS:
+                return false;
+            case SUGAR_CANE_BLOCK:
+                return false;
+            case WALL_SIGN:
+                return false;
+            case SIGN_POST:
+                return false;
+            case WOODEN_DOOR:
+                return false;
+            case STATIONARY_WATER:
+                return false;
+            case WATER:
+                return false;
+            default:
+                return true;
+        }
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public boolean isEntitiyOnTrack(Location l) {
+        Material currentBlock = l.getBlock().getType();
+        return (currentBlock == Material.POWERED_RAIL || currentBlock == Material.DETECTOR_RAIL || currentBlock == Material.RAILS);
+    }
+
+    /**
+     * Checks recursively below a {@link Location} for 2 blocks of water.
+     *
+     * @param l The {@link Location}
+     * @return Whether there are 2 blocks of water
+     */
+    private boolean hasTwoBlocksofWaterBelow(Location l) {
+        if (l.getBlockY() < 0) {
+            return false;
+        }
+        Location oneBelow = l.clone();
+        oneBelow.subtract(0, 1, 0);
+        if (oneBelow.getBlock().getType() == Material.WATER || oneBelow.getBlock().getType() == Material.STATIONARY_WATER) {
+            Location twoBelow = oneBelow.clone();
+            twoBelow.subtract(0, 1, 0);
+            return (oneBelow.getBlock().getType() == Material.WATER || oneBelow.getBlock().getType() == Material.STATIONARY_WATER);
+        }
+        if (oneBelow.getBlock().getType() != Material.AIR) {
+            return false;
+        }
+        return hasTwoBlocksofWaterBelow(oneBelow);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public boolean canSpawnCartSafely(Minecart cart) {
+        if (this.isBlockAboveAir(cart.getLocation())) {
+            return true;
+        }
+        if (this.isEntitiyOnTrack(LocationManipulation.getNextBlock(cart))) {
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public boolean canSpawnVehicleSafely(Vehicle vehicle) {
+        if (this.isBlockAboveAir(vehicle.getLocation())) {
+            return true;
+        }
+        return false;
+    }
+
+}