477 lines
18 KiB
Java
477 lines
18 KiB
Java
/*
|
|
* WorldEdit, a Minecraft world manipulation toolkit
|
|
* Copyright (C) sk89q <http://www.sk89q.com>
|
|
* Copyright (C) WorldEdit team and contributors
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU 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 General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
package com.sk89q.worldedit.extension.platform;
|
|
|
|
import com.boydti.fawe.config.Settings;
|
|
import com.boydti.fawe.object.brush.visualization.VirtualWorld;
|
|
import com.boydti.fawe.object.exception.FaweException;
|
|
import com.boydti.fawe.object.pattern.PatternTraverser;
|
|
import com.boydti.fawe.wrappers.LocationMaskedPlayerWrapper;
|
|
import com.boydti.fawe.wrappers.WorldWrapper;
|
|
import com.sk89q.worldedit.LocalConfiguration;
|
|
import com.sk89q.worldedit.LocalSession;
|
|
import com.sk89q.worldedit.WorldEdit;
|
|
import com.sk89q.worldedit.command.tool.BlockTool;
|
|
import com.sk89q.worldedit.command.tool.BrushTool;
|
|
import com.sk89q.worldedit.command.tool.DoubleActionBlockTool;
|
|
import com.sk89q.worldedit.command.tool.DoubleActionTraceTool;
|
|
import com.sk89q.worldedit.command.tool.Tool;
|
|
import com.sk89q.worldedit.command.tool.TraceTool;
|
|
import com.sk89q.worldedit.entity.Player;
|
|
import com.sk89q.worldedit.event.platform.BlockInteractEvent;
|
|
import com.sk89q.worldedit.event.platform.ConfigurationLoadEvent;
|
|
import com.sk89q.worldedit.event.platform.Interaction;
|
|
import com.sk89q.worldedit.event.platform.PlatformInitializeEvent;
|
|
import com.sk89q.worldedit.event.platform.PlatformReadyEvent;
|
|
import com.sk89q.worldedit.event.platform.PlayerInputEvent;
|
|
import com.sk89q.worldedit.internal.util.LogManagerCompat;
|
|
import com.sk89q.worldedit.math.Vector3;
|
|
import com.sk89q.worldedit.session.request.Request;
|
|
import com.sk89q.worldedit.util.Location;
|
|
import com.sk89q.worldedit.util.SideEffect;
|
|
import com.sk89q.worldedit.util.eventbus.Subscribe;
|
|
import com.sk89q.worldedit.util.formatting.text.TranslatableComponent;
|
|
import com.sk89q.worldedit.world.World;
|
|
import org.apache.logging.log4j.Logger;
|
|
|
|
import java.util.ArrayList;
|
|
import java.util.Collection;
|
|
import java.util.EnumMap;
|
|
import java.util.Iterator;
|
|
import java.util.List;
|
|
import java.util.Map;
|
|
import java.util.Map.Entry;
|
|
import java.util.concurrent.atomic.AtomicBoolean;
|
|
import javax.annotation.Nullable;
|
|
|
|
import static com.google.common.base.Preconditions.checkNotNull;
|
|
|
|
/**
|
|
* Manages registered {@link Platform}s for WorldEdit. Platforms are
|
|
* implementations of WorldEdit.
|
|
*
|
|
* <p>This class is thread-safe.</p>
|
|
*/
|
|
public class PlatformManager {
|
|
|
|
private static final Logger LOGGER = LogManagerCompat.getLogger();
|
|
|
|
private final WorldEdit worldEdit;
|
|
private final PlatformCommandManager platformCommandManager;
|
|
private final List<Platform> platforms = new ArrayList<>();
|
|
private final Map<Capability, Platform> preferences = new EnumMap<>(Capability.class);
|
|
@Nullable
|
|
private String firstSeenVersion;
|
|
private final AtomicBoolean initialized = new AtomicBoolean();
|
|
private final AtomicBoolean configured = new AtomicBoolean();
|
|
|
|
/**
|
|
* Create a new platform manager.
|
|
*
|
|
* @param worldEdit the WorldEdit instance
|
|
*/
|
|
public PlatformManager(WorldEdit worldEdit) {
|
|
checkNotNull(worldEdit);
|
|
this.worldEdit = worldEdit;
|
|
this.platformCommandManager = new PlatformCommandManager(worldEdit, this);
|
|
|
|
// Register this instance for events
|
|
worldEdit.getEventBus().register(this);
|
|
}
|
|
|
|
/**
|
|
* Register a platform with WorldEdit.
|
|
*
|
|
* @param platform the platform
|
|
*/
|
|
public synchronized void register(Platform platform) {
|
|
checkNotNull(platform);
|
|
|
|
LOGGER.info("Got request to register " + platform.getClass() + " with WorldEdit [" + super.toString() + "]");
|
|
|
|
// Just add the platform to the list of platforms: we'll pick favorites
|
|
// once all the platforms have been loaded
|
|
platforms.add(platform);
|
|
|
|
// Make sure that versions are in sync
|
|
if (firstSeenVersion != null) {
|
|
if (!firstSeenVersion.equals(platform.getVersion())) {
|
|
LOGGER.warn("Multiple ports of WorldEdit are installed but they report different versions ({} and {}). "
|
|
+ "If these two versions are truly different, then you may run into unexpected crashes and errors.", firstSeenVersion, platform.getVersion());
|
|
}
|
|
} else {
|
|
firstSeenVersion = platform.getVersion();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Unregister a platform from WorldEdit.
|
|
*
|
|
* <p>If the platform has been chosen for any capabilities, then a new
|
|
* platform will be found.</p>
|
|
*
|
|
* @param platform the platform
|
|
*/
|
|
public synchronized boolean unregister(Platform platform) {
|
|
checkNotNull(platform);
|
|
|
|
boolean removed = platforms.remove(platform);
|
|
|
|
if (removed) {
|
|
LOGGER.info("Unregistering " + platform.getClass().getCanonicalName() + " from WorldEdit");
|
|
|
|
boolean choosePreferred = false;
|
|
|
|
// Check whether this platform was chosen to be the preferred one
|
|
// for any capability and be sure to remove it
|
|
Iterator<Entry<Capability, Platform>> it = preferences.entrySet().iterator();
|
|
while (it.hasNext()) {
|
|
Entry<Capability, Platform> entry = it.next();
|
|
if (entry.getValue().equals(platform)) {
|
|
entry.getKey().unload(this, entry.getValue());
|
|
it.remove();
|
|
choosePreferred = true; // Have to choose new favorites
|
|
}
|
|
}
|
|
|
|
if (choosePreferred) {
|
|
choosePreferred();
|
|
}
|
|
}
|
|
|
|
return removed;
|
|
}
|
|
|
|
/**
|
|
* Get the preferred platform for handling a certain capability. Returns
|
|
* null if none is available.
|
|
*
|
|
* @param capability the capability
|
|
* @return the platform
|
|
* @throws NoCapablePlatformException thrown if no platform is capable
|
|
*/
|
|
public synchronized Platform queryCapability(Capability capability) throws NoCapablePlatformException {
|
|
Platform platform = preferences.get(checkNotNull(capability));
|
|
if (platform != null) {
|
|
return platform;
|
|
} else {
|
|
if (preferences.isEmpty()) {
|
|
// Use the first available if preferences have not been decided yet.
|
|
if (platforms.isEmpty()) {
|
|
// No platforms registered, this is being called too early!
|
|
throw new NoCapablePlatformException("No platforms have been registered yet! Please wait until WorldEdit is initialized.");
|
|
}
|
|
return platforms.get(0);
|
|
}
|
|
throw new NoCapablePlatformException("No platform was found supporting " + capability.name());
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Choose preferred platforms and perform necessary initialization.
|
|
*/
|
|
private synchronized void choosePreferred() {
|
|
for (Capability capability : Capability.values()) {
|
|
Platform preferred = findMostPreferred(capability);
|
|
if (preferred != null) {
|
|
preferences.put(capability, preferred);
|
|
capability.initialize(this, preferred);
|
|
}
|
|
}
|
|
|
|
// Fire configuration event
|
|
if (preferences.containsKey(Capability.CONFIGURATION) && configured.compareAndSet(false, true)) {
|
|
worldEdit.getEventBus().post(new ConfigurationLoadEvent(queryCapability(Capability.CONFIGURATION).getConfiguration()));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Find the most preferred platform for a given capability from the list of
|
|
* platforms. This does not use the map of preferred platforms.
|
|
*
|
|
* @param capability the capability
|
|
* @return the most preferred platform, or null if no platform was found
|
|
*/
|
|
@Nullable
|
|
private synchronized Platform findMostPreferred(Capability capability) {
|
|
Platform preferred = null;
|
|
Preference highest = null;
|
|
|
|
for (Platform platform : platforms) {
|
|
Preference preference = platform.getCapabilities().get(capability);
|
|
if (preference != null && (highest == null || preference.isPreferredOver(highest))) {
|
|
preferred = platform;
|
|
highest = preference;
|
|
}
|
|
}
|
|
|
|
return preferred;
|
|
}
|
|
|
|
/**
|
|
* Get a list of loaded platforms.
|
|
*
|
|
* <p>The returned list is a copy of the original and is mutable.</p>
|
|
*
|
|
* @return a list of platforms
|
|
*/
|
|
public synchronized List<Platform> getPlatforms() {
|
|
return new ArrayList<>(platforms);
|
|
}
|
|
|
|
/**
|
|
* Given a world, possibly return the same world but using a different
|
|
* platform preferred for world editing operations.
|
|
*
|
|
* @param base the world to match
|
|
* @return the preferred world, if one was found, otherwise the given world
|
|
*/
|
|
public World getWorldForEditing(World base) {
|
|
checkNotNull(base);
|
|
base = WorldWrapper.unwrap(base);
|
|
World match = queryCapability(Capability.WORLD_EDITING).matchWorld(base);
|
|
return match != null ? match : base;
|
|
}
|
|
|
|
/**
|
|
* Given an actor, return a new one that may use a different platform
|
|
* for permissions and world editing.
|
|
*
|
|
* @param base the base actor to match
|
|
* @return a new delegate actor
|
|
*/
|
|
@SuppressWarnings("unchecked")
|
|
public <T extends Actor> T createProxyActor(T base) {
|
|
checkNotNull(base);
|
|
|
|
if (base instanceof Player) {
|
|
Player player = (Player) base;
|
|
|
|
Player permActor = queryCapability(Capability.PERMISSIONS).matchPlayer(player);
|
|
if (permActor == null) {
|
|
permActor = player;
|
|
}
|
|
|
|
Player cuiActor = queryCapability(Capability.WORLDEDIT_CUI).matchPlayer(player);
|
|
if (cuiActor == null) {
|
|
cuiActor = player;
|
|
}
|
|
if (player == permActor && player == cuiActor) {
|
|
return (T) proxyFawe(player);
|
|
}
|
|
return (T) proxyFawe(new PlayerProxy(player, permActor, cuiActor, getWorldForEditing(player.getWorld())));
|
|
} else {
|
|
return base;
|
|
}
|
|
}
|
|
|
|
private <T extends Player> T proxyFawe(T player) {
|
|
return (T) new LocationMaskedPlayerWrapper(player, player.getLocation(), true);
|
|
}
|
|
|
|
/**
|
|
* Get the command manager.
|
|
*
|
|
* @return the command manager
|
|
*/
|
|
public PlatformCommandManager getPlatformCommandManager() {
|
|
return platformCommandManager;
|
|
}
|
|
|
|
/**
|
|
* Get the current configuration.
|
|
*
|
|
* <p>If no platform has been registered yet, then a default configuration
|
|
* will be returned.</p>
|
|
*
|
|
* @return the configuration
|
|
*/
|
|
public LocalConfiguration getConfiguration() {
|
|
return queryCapability(Capability.CONFIGURATION).getConfiguration();
|
|
}
|
|
|
|
public Collection<SideEffect> getSupportedSideEffects() {
|
|
return queryCapability(Capability.WORLD_EDITING).getSupportedSideEffects();
|
|
}
|
|
|
|
@Subscribe
|
|
public void handlePlatformReady(PlatformReadyEvent event) {
|
|
choosePreferred();
|
|
if (initialized.compareAndSet(false, true)) {
|
|
worldEdit.getEventBus().post(new PlatformInitializeEvent());
|
|
}
|
|
}
|
|
|
|
private <T extends Tool> T reset(T tool) {
|
|
new PatternTraverser(tool).reset(null);
|
|
return tool;
|
|
}
|
|
|
|
@Subscribe
|
|
public void handleBlockInteract(BlockInteractEvent event) {
|
|
// Create a proxy actor with a potentially different world for
|
|
// making changes to the world
|
|
Actor actor = createProxyActor(event.getCause());
|
|
|
|
Location location = event.getLocation();
|
|
|
|
// At this time, only handle interaction from players
|
|
if (!(actor instanceof Player)) {
|
|
return;
|
|
}
|
|
Player player = (Player) actor;
|
|
LocalSession session = worldEdit.getSessionManager().get(actor);
|
|
|
|
Request.reset();
|
|
Request.request().setSession(session);
|
|
Request.request().setWorld(player.getWorld());
|
|
|
|
try {
|
|
Vector3 vector = location.toVector();
|
|
|
|
VirtualWorld virtual = session.getVirtualWorld();
|
|
if (virtual != null) {
|
|
if (Settings.IMP.EXPERIMENTAL.OTHER) {
|
|
LOGGER.info("virtualWorld was not null in handlePlayerInput()");
|
|
}
|
|
|
|
virtual.handleBlockInteract(player, vector.toBlockPoint(), event);
|
|
if (event.isCancelled()) {
|
|
return;
|
|
}
|
|
}
|
|
|
|
if (event.getType() == Interaction.HIT) {
|
|
// superpickaxe is special because its primary interaction is a left click, not a right click
|
|
// in addition, it is implicitly bound to all pickaxe items, not just a single tool item
|
|
if (session.hasSuperPickAxe() && player.isHoldingPickAxe()) {
|
|
final BlockTool superPickaxe = session.getSuperPickaxe();
|
|
if (superPickaxe != null && superPickaxe.canUse(player)) {
|
|
player.runAction(() -> reset(superPickaxe)
|
|
.actPrimary(queryCapability(Capability.WORLD_EDITING),
|
|
getConfiguration(), player, session, location), false, true);
|
|
event.setCancelled(true);
|
|
return;
|
|
}
|
|
}
|
|
|
|
Tool tool = session.getTool(player);
|
|
if (tool instanceof DoubleActionBlockTool && tool.canUse(player)) {
|
|
player.runAction(() -> reset((DoubleActionBlockTool) tool)
|
|
.actSecondary(queryCapability(Capability.WORLD_EDITING),
|
|
getConfiguration(), player, session, location), false, true);
|
|
event.setCancelled(true);
|
|
}
|
|
|
|
} else if (event.getType() == Interaction.OPEN) {
|
|
Tool tool = session.getTool(player);
|
|
if (tool instanceof BlockTool && tool.canUse(player)) {
|
|
if (player.checkAction()) {
|
|
player.runAction(() -> {
|
|
BlockTool blockTool = (BlockTool) tool;
|
|
if (!(tool instanceof BrushTool)) {
|
|
blockTool = reset(blockTool);
|
|
}
|
|
blockTool.actPrimary(queryCapability(Capability.WORLD_EDITING),
|
|
getConfiguration(), player, session, location);
|
|
}, false, true);
|
|
event.setCancelled(true);
|
|
}
|
|
}
|
|
}
|
|
} catch (Throwable e) {
|
|
handleThrowable(e, actor);
|
|
} finally {
|
|
Request.reset();
|
|
}
|
|
}
|
|
|
|
public void handleThrowable(Throwable e, Actor actor) {
|
|
FaweException faweException = FaweException.get(e);
|
|
if (faweException != null) {
|
|
actor.print(TranslatableComponent.of("fawe.cancel.worldedit.cancel.reason", faweException.getComponent()));
|
|
} else {
|
|
actor.printError("Please report this error: [See console]");
|
|
actor.printRaw(e.getClass().getName() + ": " + e.getMessage());
|
|
e.printStackTrace();
|
|
}
|
|
}
|
|
|
|
@Subscribe
|
|
public void handlePlayerInput(PlayerInputEvent event) {
|
|
// Create a proxy actor with a potentially different world for
|
|
// making changes to the world
|
|
Player player = createProxyActor(event.getPlayer());
|
|
LocalSession session = worldEdit.getSessionManager().get(player);
|
|
VirtualWorld virtual = session.getVirtualWorld();
|
|
if (virtual != null) {
|
|
if (Settings.IMP.EXPERIMENTAL.OTHER) {
|
|
LOGGER.info("virtualWorld was not null in handlePlayerInput()");
|
|
}
|
|
virtual.handlePlayerInput(player, event);
|
|
if (event.isCancelled()) {
|
|
return;
|
|
}
|
|
}
|
|
|
|
try {
|
|
switch (event.getInputType()) {
|
|
case PRIMARY: {
|
|
Tool tool = session.getTool(player);
|
|
if (tool instanceof DoubleActionTraceTool && tool.canUse(player)) {
|
|
player.runAsyncIfFree(() -> reset((DoubleActionTraceTool) tool).actSecondary(queryCapability(Capability.WORLD_EDITING),
|
|
getConfiguration(), player, session));
|
|
event.setCancelled(true);
|
|
return;
|
|
}
|
|
|
|
break;
|
|
}
|
|
|
|
case SECONDARY: {
|
|
Tool tool = session.getTool(player);
|
|
if (tool instanceof TraceTool && tool.canUse(player)) {
|
|
//todo this needs to be fixed so the event is canceled after actPrimary is used and returns true
|
|
player.runAction(() -> reset((TraceTool) tool).actPrimary(queryCapability(Capability.WORLD_EDITING),
|
|
getConfiguration(), player, session), false, true);
|
|
event.setCancelled(true);
|
|
return;
|
|
}
|
|
|
|
break;
|
|
}
|
|
}
|
|
} catch (Throwable e) {
|
|
FaweException faweException = FaweException.get(e);
|
|
if (faweException != null) {
|
|
player.print(TranslatableComponent.of("fawe.cancel.worldedit.cancel.reason", faweException.getComponent()));
|
|
} else {
|
|
player.printError("Please report this error: [See console]");
|
|
player.printRaw(e.getClass().getName() + ": " + e.getMessage());
|
|
e.printStackTrace();
|
|
}
|
|
} finally {
|
|
Request.reset();
|
|
}
|
|
}
|
|
|
|
|
|
}
|