Upstream
/
WorldGuard
mirror of https://github.com/EngineHub/WorldGuard.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add optional build permission nodes.

This commit is contained in:
sk89q 2014-08-24 02:03:38 -07:00
parent 70aedb4a84
commit 541f828db4
5 changed files with 250 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
CHANGELOG.md
View File

@ -88,6 +88,25 @@ Events that tend to reoccur very frequently (such as the ones that occur when yo
A long requested feature was the availability of block place and break flags. These newly added flags work in tandem with the `BUILD` flag but can override `BUILD`. At the moment, it is not possible to allow explicit types of blocks to be placed or broken yet.
### Build permission nodes
A new optional (disabled by default in the configuration) feature is the checking of build permission nodes. For every block, entity, and item, the following permission nodes are checked:
* Block place: `worldguard.build.block.place.<material>`
* Block break: `worldguard.build.block.remove.<material>`
* Block interact: `worldguard.build.block.interact.<material>`
* Entity spawn: `worldguard.build.block.place.<type>`
* Entity destroy: `worldguard.build.block.remove.<type>`
* Entity interact: `worldguard.build.block.interact.<type>`
* Entity damage: `worldguard.build.block.damage.<type>`
* Item use: `worldguard.build.item.interact.<material>`
In addition, the permissions are also checked in the style of `worldguard.build.block.<material>.<action>`, so `worldguard.build.block.<material>.place` would work too.
The list of usable material names comes from the [Material enumeration in Bukkit](http://jd.bukkit.org/rb/apidocs/org/bukkit/Material.html). For example, the permission for placing the bed block would be `worldguard.build.build.place.bed_block`. Be aware that _Material_ contains both item and block names.
For entity names, see [EntityType](http://jd.bukkit.org/rb/apidocs/org/bukkit/entity/EntityType.html).
### Other changes
* Added a setting to permit "fake players" to bypass protection. Fake players are used by some servers and some mods to allow events to be thrown for mod blocks. WorldGuard considers a player to be a fake player if the name starts with `[` and ends with `]`.

19
UPGRADE.md
View File

@ -104,6 +104,25 @@ Events that tend to reoccur very frequently (such as the ones that occur when yo
A long requested feature was the availability of block place and break flags. These newly added flags work in tandem with the `BUILD` flag but can override `BUILD`. At the moment, it is not possible to allow explicit types of blocks to be placed or broken yet.
### Build permission nodes
A new optional (disabled by default in the configuration) feature is the checking of build permission nodes. For every block, entity, and item, the following permission nodes are checked:
* Block place: `worldguard.build.block.place.<material>`
* Block break: `worldguard.build.block.remove.<material>`
* Block interact: `worldguard.build.block.interact.<material>`
* Entity spawn: `worldguard.build.block.place.<type>`
* Entity destroy: `worldguard.build.block.remove.<type>`
* Entity interact: `worldguard.build.block.interact.<type>`
* Entity damage: `worldguard.build.block.damage.<type>`
* Item use: `worldguard.build.item.interact.<material>`
In addition, the permissions are also checked in the style of `worldguard.build.block.<material>.<action>`, so `worldguard.build.block.<material>.place` would work too.
The list of usable material names comes from the [Material enumeration in Bukkit](http://jd.bukkit.org/rb/apidocs/org/bukkit/Material.html). For example, the permission for placing the bed block would be `worldguard.build.build.place.bed_block`. Be aware that _Material_ contains both item and block names.
For entity names, see [EntityType](http://jd.bukkit.org/rb/apidocs/org/bukkit/entity/EntityType.html).
# Other changes
The rest of the changes can be found in the CHANGELOG file.

6
src/main/java/com/sk89q/worldguard/bukkit/WorldConfiguration.java
View File

@ -26,6 +26,7 @@ import com.sk89q.worldguard.blacklist.BlacklistLoggerHandler;
import com.sk89q.worldguard.blacklist.logger.ConsoleHandler;
import com.sk89q.worldguard.blacklist.logger.DatabaseHandler;
import com.sk89q.worldguard.blacklist.logger.FileHandler;
import com.sk89q.worldguard.bukkit.commands.CommandUtils;
import com.sk89q.worldguard.chest.ChestProtection;
import com.sk89q.worldguard.chest.SignChestProtection;
import org.bukkit.block.Block;
@ -79,6 +80,8 @@ public class WorldConfiguration {
/* Configuration data start */
public boolean summaryOnStart;
public boolean opPermissions;
public boolean buildPermissions;
public String buildPermissionDenyMessage = "";
public boolean fireSpreadDisableToggle;
public boolean itemDurability;
public boolean simulateSponge;
@ -311,6 +314,9 @@ public class WorldConfiguration {
summaryOnStart = getBoolean("summary-on-start", true);
opPermissions = getBoolean("op-permissions", true);
buildPermissions = getBoolean("build-permission-nodes.enable", false);
buildPermissionDenyMessage = CommandUtils.replaceColorMacros(
getString("build-permission-nodes.deny-message", "&eSorry, but you are not permitted to do that here."));
itemDurability = getBoolean("protection.item-durability", true);
removeInfiniteStacks = getBoolean("protection.remove-infinite-stacks", false);

2
src/main/java/com/sk89q/worldguard/bukkit/WorldGuardPlugin.java
View File

@ -47,6 +47,7 @@ import com.sk89q.worldguard.bukkit.commands.ToggleCommands;
import com.sk89q.worldguard.bukkit.event.player.ProcessPlayerEvent;
import com.sk89q.worldguard.bukkit.listener.BlacklistListener;
import com.sk89q.worldguard.bukkit.listener.BlockedPotionsListener;
import com.sk89q.worldguard.bukkit.listener.BuildPermissionListener;
import com.sk89q.worldguard.bukkit.listener.ChestProtectionListener;
import com.sk89q.worldguard.bukkit.listener.DebuggingListener;
import com.sk89q.worldguard.bukkit.listener.EventAbstractionListener;
@ -239,6 +240,7 @@ public class WorldGuardPlugin extends JavaPlugin {
(new BlockedPotionsListener(this)).registerEvents();
(new EventAbstractionListener(this)).registerEvents();
(new PlayerModesListener(this)).registerEvents();
(new BuildPermissionListener(this)).registerEvents();
if ("true".equalsIgnoreCase(System.getProperty("worldguard.debug.listener"))) {
(new DebuggingListener(this, log)).registerEvents();
}

204
src/main/java/com/sk89q/worldguard/bukkit/listener/BuildPermissionListener.java Normal file
View File

@ -0,0 +1,204 @@
/*
* WorldGuard, a suite of tools for Minecraft
* Copyright (C) sk89q <http://www.sk89q.com>
* Copyright (C) WorldGuard team and contributors
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by the
* Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
* for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package com.sk89q.worldguard.bukkit.listener;
import com.sk89q.worldguard.bukkit.WorldGuardPlugin;
import com.sk89q.worldguard.bukkit.event.block.BreakBlockEvent;
import com.sk89q.worldguard.bukkit.event.block.PlaceBlockEvent;
import com.sk89q.worldguard.bukkit.event.block.UseBlockEvent;
import com.sk89q.worldguard.bukkit.event.entity.DamageEntityEvent;
import com.sk89q.worldguard.bukkit.event.entity.DestroyEntityEvent;
import com.sk89q.worldguard.bukkit.event.entity.SpawnEntityEvent;
import com.sk89q.worldguard.bukkit.event.entity.UseEntityEvent;
import com.sk89q.worldguard.bukkit.event.inventory.UseItemEvent;
import org.bukkit.Material;
import org.bukkit.World;
import org.bukkit.command.CommandSender;
import org.bukkit.entity.EntityType;
import org.bukkit.entity.Player;
import org.bukkit.event.EventHandler;
public class BuildPermissionListener extends AbstractListener {
/**
* Construct the listener.
*
* @param plugin an instance of WorldGuardPlugin
*/
public BuildPermissionListener(WorldGuardPlugin plugin) {
super(plugin);
}
private boolean hasBuildPermission(CommandSender sender, String perm) {
return getPlugin().hasPermission(sender, "worldguard.build." + perm);
}
private void tellErrorMessage(CommandSender sender, World world) {
String message = getWorldConfig(world).buildPermissionDenyMessage;
if (!message.isEmpty()) {
sender.sendMessage(message);
}
}
@EventHandler(ignoreCancelled = true)
public void onPlaceBlock(final PlaceBlockEvent event) {
if (!getWorldConfig(event.getWorld()).buildPermissions) return;
Object rootCause = event.getCause().getRootCause();
if (rootCause instanceof Player) {
final Player player = (Player) rootCause;
final Material material = event.getEffectiveMaterial();
if (!hasBuildPermission(player, "block." + material.name().toLowerCase() + ".place")
&& !hasBuildPermission(player, "block.place." + material.name().toLowerCase())) {
tellErrorMessage(player, event.getWorld());
event.setCancelled(true);
}
}
}
@EventHandler(ignoreCancelled = true)
public void onBreakBlock(final BreakBlockEvent event) {
if (!getWorldConfig(event.getWorld()).buildPermissions) return;
Object rootCause = event.getCause().getRootCause();
if (rootCause instanceof Player) {
final Player player = (Player) rootCause;
final Material material = event.getEffectiveMaterial();
if (!hasBuildPermission(player, "block." + material.name().toLowerCase() + ".remove")
&& !hasBuildPermission(player, "block.remove." + material.name().toLowerCase())) {
tellErrorMessage(player, event.getWorld());
event.setCancelled(true);
}
}
}
@EventHandler(ignoreCancelled = true)
public void onUseBlock(final UseBlockEvent event) {
if (!getWorldConfig(event.getWorld()).buildPermissions) return;
Object rootCause = event.getCause().getRootCause();
if (rootCause instanceof Player) {
final Player player = (Player) rootCause;
final Material material = event.getEffectiveMaterial();
if (!hasBuildPermission(player, "block." + material.name().toLowerCase() + ".interact")
&& !hasBuildPermission(player, "block.interact." + material.name().toLowerCase())) {
tellErrorMessage(player, event.getWorld());
event.setCancelled(true);
}
}
}
@EventHandler(ignoreCancelled = true)
public void onSpawnEntity(SpawnEntityEvent event) {
if (!getWorldConfig(event.getWorld()).buildPermissions) return;
Object rootCause = event.getCause().getRootCause();
if (rootCause instanceof Player) {
final Player player = (Player) rootCause;
final EntityType type = event.getEffectiveType();
if (!hasBuildPermission(player, "entity." + type.name().toLowerCase() + ".place")
&& !hasBuildPermission(player, "entity.place." + type.name().toLowerCase())) {
tellErrorMessage(player, event.getWorld());
event.setCancelled(true);
}
}
}
@EventHandler(ignoreCancelled = true)
public void onDestroyEntity(DestroyEntityEvent event) {
if (!getWorldConfig(event.getWorld()).buildPermissions) return;
Object rootCause = event.getCause().getRootCause();
if (rootCause instanceof Player) {
final Player player = (Player) rootCause;
final EntityType type = event.getEntity().getType();
if (!hasBuildPermission(player, "entity." + type.name().toLowerCase() + ".remove")
&& !hasBuildPermission(player, "entity.remove." + type.name().toLowerCase())) {
tellErrorMessage(player, event.getWorld());
event.setCancelled(true);
}
}
}
@EventHandler(ignoreCancelled = true)
public void onUseEntity(UseEntityEvent event) {
if (!getWorldConfig(event.getWorld()).buildPermissions) return;
Object rootCause = event.getCause().getRootCause();
if (rootCause instanceof Player) {
final Player player = (Player) rootCause;
final EntityType type = event.getEntity().getType();
if (!hasBuildPermission(player, "entity." + type.name().toLowerCase() + ".interact")
&& !hasBuildPermission(player, "entity.interact." + type.name().toLowerCase())) {
tellErrorMessage(player, event.getWorld());
event.setCancelled(true);
}
}
}
@EventHandler(ignoreCancelled = true)
public void onDamageEntity(DamageEntityEvent event) {
if (!getWorldConfig(event.getWorld()).buildPermissions) return;
Object rootCause = event.getCause().getRootCause();
if (rootCause instanceof Player) {
final Player player = (Player) rootCause;
final EntityType type = event.getEntity().getType();
if (!hasBuildPermission(player, "entity." + type.name().toLowerCase() + ".damage")
&& !hasBuildPermission(player, "entity.damage." + type.name().toLowerCase())) {
tellErrorMessage(player, event.getWorld());
event.setCancelled(true);
}
}
}
@EventHandler(ignoreCancelled = true)
public void onUseItem(UseItemEvent event) {
if (!getWorldConfig(event.getWorld()).buildPermissions) return;
Object rootCause = event.getCause().getRootCause();
if (rootCause instanceof Player) {
Player player = (Player) rootCause;
Material material = event.getItemStack().getType();
if (!hasBuildPermission(player, "item." + material.name().toLowerCase() + ".interact")
|| hasBuildPermission(player, "item.interact." + material.name().toLowerCase())) {
tellErrorMessage(player, event.getWorld());
event.setCancelled(true);
}
}
}
}