484 lines
19 KiB
Java
484 lines
19 KiB
Java
/*
|
|
* This file is part of ViaVersion - https://github.com/ViaVersion/ViaVersion
|
|
* Copyright (C) 2016-2021 ViaVersion 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 <http://www.gnu.org/licenses/>.
|
|
*/
|
|
package com.viaversion.viaversion.rewriter;
|
|
|
|
import com.github.steveice10.opennbt.tag.builtin.CompoundTag;
|
|
import com.github.steveice10.opennbt.tag.builtin.IntTag;
|
|
import com.github.steveice10.opennbt.tag.builtin.Tag;
|
|
import com.google.common.base.Preconditions;
|
|
import com.viaversion.viaversion.api.Via;
|
|
import com.viaversion.viaversion.api.connection.UserConnection;
|
|
import com.viaversion.viaversion.api.data.ParticleMappings;
|
|
import com.viaversion.viaversion.api.data.entity.EntityTracker;
|
|
import com.viaversion.viaversion.api.minecraft.entities.EntityType;
|
|
import com.viaversion.viaversion.api.minecraft.metadata.MetaType;
|
|
import com.viaversion.viaversion.api.minecraft.metadata.Metadata;
|
|
import com.viaversion.viaversion.api.protocol.Protocol;
|
|
import com.viaversion.viaversion.api.protocol.packet.ClientboundPacketType;
|
|
import com.viaversion.viaversion.api.protocol.remapper.PacketHandler;
|
|
import com.viaversion.viaversion.api.protocol.remapper.PacketRemapper;
|
|
import com.viaversion.viaversion.api.rewriter.RewriterBase;
|
|
import com.viaversion.viaversion.api.type.Type;
|
|
import com.viaversion.viaversion.api.type.types.Particle;
|
|
import com.viaversion.viaversion.rewriter.meta.MetaFilter;
|
|
import com.viaversion.viaversion.rewriter.meta.MetaHandlerEvent;
|
|
import com.viaversion.viaversion.rewriter.meta.MetaHandlerEventImpl;
|
|
import it.unimi.dsi.fastutil.ints.Int2IntMap;
|
|
import it.unimi.dsi.fastutil.ints.Int2IntOpenHashMap;
|
|
import org.checkerframework.checker.nullness.qual.Nullable;
|
|
|
|
import java.util.ArrayList;
|
|
import java.util.Comparator;
|
|
import java.util.List;
|
|
import java.util.logging.Logger;
|
|
import java.util.stream.Collectors;
|
|
|
|
public abstract class EntityRewriter<T extends Protocol> extends RewriterBase<T> implements com.viaversion.viaversion.api.rewriter.EntityRewriter<T> {
|
|
private static final Metadata[] EMPTY_ARRAY = new Metadata[0];
|
|
protected final List<MetaFilter> metadataFilters = new ArrayList<>();
|
|
protected final boolean trackMappedType;
|
|
protected Int2IntMap typeMappings;
|
|
|
|
protected EntityRewriter(T protocol) {
|
|
this(protocol, true);
|
|
}
|
|
|
|
/**
|
|
* Creates a new entity rewriter instance.
|
|
*
|
|
* @param protocol protocol
|
|
* @param trackMappedType whether the mapped or unmapped entity type should be tracked
|
|
*/
|
|
protected EntityRewriter(T protocol, boolean trackMappedType) {
|
|
super(protocol);
|
|
this.trackMappedType = trackMappedType;
|
|
protocol.put(this);
|
|
}
|
|
|
|
/**
|
|
* Returns a meta filter builder.
|
|
* <p>
|
|
* Calling {@link MetaFilter.Builder#register()} will automatically register the filter on this rewriter.
|
|
*
|
|
* @return meta filter builder
|
|
*/
|
|
public MetaFilter.Builder filter() {
|
|
return new MetaFilter.Builder(this);
|
|
}
|
|
|
|
/**
|
|
* Registers a metadata filter.
|
|
* Note that {@link MetaFilter.Builder#register()} already calls this method.
|
|
*
|
|
* @param filter filter to register
|
|
* @throws IllegalArgumentException if the filter is already registered
|
|
*/
|
|
public void registerFilter(MetaFilter filter) {
|
|
Preconditions.checkArgument(!metadataFilters.contains(filter));
|
|
metadataFilters.add(filter);
|
|
}
|
|
|
|
@Override
|
|
public void handleMetadata(int entityId, List<Metadata> metadataList, UserConnection connection) {
|
|
EntityType type = tracker(connection).entityType(entityId);
|
|
int i = 0; // Count index for fast removal
|
|
for (Metadata metadata : metadataList.toArray(EMPTY_ARRAY)) { // Copy the list to allow mutation
|
|
// Call handlers implementing the old handleMetadata
|
|
if (!callOldMetaHandler(entityId, type, metadata, metadataList, connection)) {
|
|
metadataList.remove(i--);
|
|
continue;
|
|
}
|
|
|
|
MetaHandlerEvent event = null;
|
|
for (MetaFilter filter : metadataFilters) {
|
|
if (!filter.isFiltered(type, metadata)) {
|
|
continue;
|
|
}
|
|
if (event == null) {
|
|
// Only initialize when needed and share event instance
|
|
event = new MetaHandlerEventImpl(connection, type, entityId, metadata, metadataList);
|
|
}
|
|
|
|
try {
|
|
filter.handler().handle(event, metadata);
|
|
} catch (Exception e) {
|
|
logException(e, type, metadataList, metadata);
|
|
metadataList.remove(i--);
|
|
break;
|
|
}
|
|
|
|
if (event.cancelled()) {
|
|
// Remove meta, decrease list index counter, and break current filter loop
|
|
metadataList.remove(i--);
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (event != null && event.extraMeta() != null) {
|
|
// Finally add newly created meta
|
|
metadataList.addAll(event.extraMeta());
|
|
}
|
|
i++;
|
|
}
|
|
}
|
|
|
|
@Deprecated
|
|
private boolean callOldMetaHandler(int entityId, @Nullable EntityType type, Metadata metadata, List<Metadata> metadataList, UserConnection connection) {
|
|
try {
|
|
handleMetadata(entityId, type, metadata, metadataList, connection);
|
|
return true;
|
|
} catch (Exception e) {
|
|
logException(e, type, metadataList, metadata);
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* To be overridden to handle metadata.
|
|
*
|
|
* @param entityId entity id
|
|
* @param type entity type, or null if not tracked
|
|
* @param metadata current metadata
|
|
* @param metadatas full, mutable list of metadata
|
|
* @param connection user connection
|
|
* @deprecated use {@link #filter()}
|
|
*/
|
|
@Deprecated
|
|
protected void handleMetadata(int entityId, @Nullable EntityType type, Metadata metadata, List<Metadata> metadatas, UserConnection connection) throws Exception {
|
|
}
|
|
|
|
@Override
|
|
public int newEntityId(int id) {
|
|
return typeMappings != null ? typeMappings.getOrDefault(id, id) : id;
|
|
}
|
|
|
|
/**
|
|
* Maps an entity type.
|
|
*
|
|
* @param type entity type
|
|
* @param mappedType mapped entity type
|
|
* @throws IllegalArgumentException if the types share the same implementing class
|
|
*/
|
|
public void mapEntityType(EntityType type, EntityType mappedType) {
|
|
Preconditions.checkArgument(type.getClass() != mappedType.getClass(), "EntityTypes should not be of the same class/enum");
|
|
mapEntityType(type.getId(), mappedType.getId());
|
|
}
|
|
|
|
protected void mapEntityType(int id, int mappedId) {
|
|
if (typeMappings == null) {
|
|
typeMappings = new Int2IntOpenHashMap();
|
|
typeMappings.defaultReturnValue(-1);
|
|
}
|
|
typeMappings.put(id, mappedId);
|
|
}
|
|
|
|
/**
|
|
* Maps entity ids based on the enum constant's names.
|
|
*
|
|
* @param oldTypes entity types of the higher version
|
|
* @param newTypeClass entity types enum class of the lower version
|
|
* @param <E> new enum entity type
|
|
*/
|
|
public <E extends Enum<E> & EntityType> void mapTypes(EntityType[] oldTypes, Class<E> newTypeClass) {
|
|
if (typeMappings == null) {
|
|
typeMappings = new Int2IntOpenHashMap(oldTypes.length, 1F);
|
|
typeMappings.defaultReturnValue(-1);
|
|
}
|
|
for (EntityType oldType : oldTypes) {
|
|
try {
|
|
E newType = Enum.valueOf(newTypeClass, oldType.name());
|
|
typeMappings.put(oldType.getId(), newType.getId());
|
|
} catch (IllegalArgumentException notFound) {
|
|
if (!typeMappings.containsKey(oldType.getId())) {
|
|
Via.getPlatform().getLogger().warning("Could not find new entity type for " + oldType + "! " +
|
|
"Old type: " + oldType.getClass().getEnclosingClass().getSimpleName() + ", new type: " + newTypeClass.getEnclosingClass().getSimpleName());
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Registers a metadata handler to rewrite, item, block, and particle ids stored in metadata.
|
|
*
|
|
* @param itemType item meta type if needed
|
|
* @param blockType block meta type if needed
|
|
* @param particleType particle meta type if needed
|
|
*/
|
|
public void registerMetaTypeHandler(@Nullable MetaType itemType, @Nullable MetaType blockType, @Nullable MetaType particleType) {
|
|
filter().handler((event, meta) -> {
|
|
if (itemType != null && meta.metaType() == itemType) {
|
|
protocol.getItemRewriter().handleItemToClient(meta.value());
|
|
} else if (blockType != null && meta.metaType() == blockType) {
|
|
int data = meta.value();
|
|
meta.setValue(protocol.getMappingData().getNewBlockStateId(data));
|
|
} else if (particleType != null && meta.metaType() == particleType) {
|
|
rewriteParticle(meta.value());
|
|
}
|
|
});
|
|
}
|
|
|
|
public void registerTracker(ClientboundPacketType packetType) {
|
|
protocol.registerClientbound(packetType, new PacketRemapper() {
|
|
@Override
|
|
public void registerMap() {
|
|
map(Type.VAR_INT); // 0 - Entity ID
|
|
map(Type.UUID); // 1 - Entity UUID
|
|
map(Type.VAR_INT); // 2 - Entity Type
|
|
handler(trackerHandler());
|
|
}
|
|
});
|
|
}
|
|
|
|
public void registerTrackerWithData(ClientboundPacketType packetType, EntityType fallingBlockType) {
|
|
protocol.registerClientbound(packetType, new PacketRemapper() {
|
|
@Override
|
|
public void registerMap() {
|
|
map(Type.VAR_INT); // 0 - Entity id
|
|
map(Type.UUID); // 1 - Entity UUID
|
|
map(Type.VAR_INT); // 2 - Entity Type
|
|
map(Type.DOUBLE); // 3 - X
|
|
map(Type.DOUBLE); // 4 - Y
|
|
map(Type.DOUBLE); // 5 - Z
|
|
map(Type.BYTE); // 6 - Pitch
|
|
map(Type.BYTE); // 7 - Yaw
|
|
map(Type.INT); // 8 - Data
|
|
handler(trackerHandler());
|
|
handler(wrapper -> {
|
|
int entityId = wrapper.get(Type.VAR_INT, 0);
|
|
EntityType entityType = tracker(wrapper.user()).entityType(entityId);
|
|
if (entityType == fallingBlockType) {
|
|
wrapper.set(Type.INT, 0, protocol.getMappingData().getNewBlockStateId(wrapper.get(Type.INT, 0)));
|
|
}
|
|
});
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Registers an entity tracker for the extra spawn packets like player, painting, or xp orb spawns.
|
|
*
|
|
* @param packetType packet type
|
|
* @param entityType entity type
|
|
* @param intType int type of the entity id
|
|
*/
|
|
public void registerTracker(ClientboundPacketType packetType, EntityType entityType, Type<?> intType) {
|
|
protocol.registerClientbound(packetType, new PacketRemapper() {
|
|
@Override
|
|
public void registerMap() {
|
|
handler(wrapper -> {
|
|
int entityId = (int) wrapper.passthrough(intType);
|
|
tracker(wrapper.user()).addEntity(entityId, entityType);
|
|
});
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Registers an entity tracker for the extra spawn packets.
|
|
*
|
|
* @param packetType packet type
|
|
* @param entityType entity type
|
|
*/
|
|
public void registerTracker(ClientboundPacketType packetType, EntityType entityType) {
|
|
registerTracker(packetType, entityType, Type.VAR_INT);
|
|
}
|
|
|
|
/**
|
|
* Sub 1.17 method for entity remove packets.
|
|
*
|
|
* @param packetType remove entities packet type
|
|
*/
|
|
public void registerRemoveEntities(ClientboundPacketType packetType) {
|
|
protocol.registerClientbound(packetType, new PacketRemapper() {
|
|
@Override
|
|
public void registerMap() {
|
|
handler(wrapper -> {
|
|
int[] entityIds = wrapper.passthrough(Type.VAR_INT_ARRAY_PRIMITIVE);
|
|
EntityTracker entityTracker = tracker(wrapper.user());
|
|
for (int entity : entityIds) {
|
|
entityTracker.removeEntity(entity);
|
|
}
|
|
});
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* 1.17+ method for entity remove packets.
|
|
*
|
|
* @param packetType remove entities packet type
|
|
*/
|
|
public void registerRemoveEntity(ClientboundPacketType packetType) {
|
|
protocol.registerClientbound(packetType, new PacketRemapper() {
|
|
@Override
|
|
public void registerMap() {
|
|
handler(wrapper -> {
|
|
int entityId = wrapper.passthrough(Type.VAR_INT);
|
|
tracker(wrapper.user()).removeEntity(entityId);
|
|
});
|
|
}
|
|
});
|
|
}
|
|
|
|
public void registerMetadataRewriter(ClientboundPacketType packetType, @Nullable Type<List<Metadata>> oldMetaType, Type<List<Metadata>> newMetaType) {
|
|
protocol.registerClientbound(packetType, new PacketRemapper() {
|
|
@Override
|
|
public void registerMap() {
|
|
map(Type.VAR_INT); // 0 - Entity ID
|
|
if (oldMetaType != null) {
|
|
map(oldMetaType, newMetaType);
|
|
} else {
|
|
map(newMetaType);
|
|
}
|
|
handler(wrapper -> {
|
|
int entityId = wrapper.get(Type.VAR_INT, 0);
|
|
List<Metadata> metadata = wrapper.get(newMetaType, 0);
|
|
handleMetadata(entityId, metadata, wrapper.user());
|
|
});
|
|
}
|
|
});
|
|
}
|
|
|
|
public void registerMetadataRewriter(ClientboundPacketType packetType, Type<List<Metadata>> metaType) {
|
|
registerMetadataRewriter(packetType, null, metaType);
|
|
}
|
|
|
|
public PacketHandler trackerHandler() {
|
|
return trackerAndRewriterHandler(null);
|
|
}
|
|
|
|
protected PacketHandler worldDataTrackerHandler(int nbtIndex) {
|
|
return wrapper -> {
|
|
EntityTracker tracker = tracker(wrapper.user());
|
|
|
|
CompoundTag registryData = wrapper.get(Type.NBT, nbtIndex);
|
|
Tag height = registryData.get("height");
|
|
if (height instanceof IntTag) {
|
|
int blockHeight = ((IntTag) height).asInt();
|
|
tracker.setCurrentWorldSectionHeight(blockHeight >> 4);
|
|
} else {
|
|
Via.getPlatform().getLogger().warning("Height missing in dimension data: " + registryData);
|
|
}
|
|
|
|
Tag minY = registryData.get("min_y");
|
|
if (minY instanceof IntTag) {
|
|
tracker.setCurrentMinY(((IntTag) minY).asInt());
|
|
} else {
|
|
Via.getPlatform().getLogger().warning("Min Y missing in dimension data: " + registryData);
|
|
}
|
|
};
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Sub 1.14.1 methods
|
|
|
|
/**
|
|
* Returns a packethandler to track and rewrite an entity.
|
|
*
|
|
* @param metaType type of the metadata list
|
|
* @return handler for tracking and rewriting entities
|
|
*/
|
|
public PacketHandler trackerAndRewriterHandler(@Nullable Type<List<Metadata>> metaType) {
|
|
return wrapper -> {
|
|
int entityId = wrapper.get(Type.VAR_INT, 0);
|
|
int type = wrapper.get(Type.VAR_INT, 1);
|
|
|
|
int newType = newEntityId(type);
|
|
if (newType != type) {
|
|
wrapper.set(Type.VAR_INT, 1, newType);
|
|
}
|
|
|
|
EntityType entType = typeFromId(trackMappedType ? newType : type);
|
|
// Register Type ID
|
|
tracker(wrapper.user()).addEntity(entityId, entType);
|
|
|
|
if (metaType != null) {
|
|
handleMetadata(entityId, wrapper.get(metaType, 0), wrapper.user());
|
|
}
|
|
};
|
|
}
|
|
|
|
public PacketHandler trackerAndRewriterHandler(@Nullable Type<List<Metadata>> metaType, EntityType entityType) {
|
|
return wrapper -> {
|
|
int entityId = wrapper.get(Type.VAR_INT, 0);
|
|
// Register Type ID
|
|
tracker(wrapper.user()).addEntity(entityId, entityType);
|
|
|
|
if (metaType != null) {
|
|
handleMetadata(entityId, wrapper.get(metaType, 0), wrapper.user());
|
|
}
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Returns a packethandler to track an object entity.
|
|
*
|
|
* @return handler for tracking and rewriting entities
|
|
*/
|
|
public PacketHandler objectTrackerHandler() {
|
|
return wrapper -> {
|
|
int entityId = wrapper.get(Type.VAR_INT, 0);
|
|
byte type = wrapper.get(Type.BYTE, 0);
|
|
|
|
EntityType entType = objectTypeFromId(type);
|
|
// Register Type ID
|
|
tracker(wrapper.user()).addEntity(entityId, entType);
|
|
};
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
@Deprecated
|
|
protected @Nullable Metadata metaByIndex(int index, List<Metadata> metadataList) {
|
|
for (Metadata metadata : metadataList) {
|
|
if (metadata.id() == index) {
|
|
return metadata;
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
|
|
protected void rewriteParticle(Particle particle) {
|
|
ParticleMappings mappings = protocol.getMappingData().getParticleMappings();
|
|
int id = particle.getId();
|
|
if (id == mappings.getBlockId() || id == mappings.getFallingDustId()) {
|
|
Particle.ParticleData data = particle.getArguments().get(0);
|
|
data.setValue(protocol.getMappingData().getNewBlockStateId(data.get()));
|
|
} else if (id == mappings.getItemId()) {
|
|
Particle.ParticleData data = particle.getArguments().get(0);
|
|
data.setValue(protocol.getMappingData().getNewItemId(data.get()));
|
|
}
|
|
|
|
particle.setId(protocol.getMappingData().getNewParticleId(id));
|
|
}
|
|
|
|
private void logException(Exception e, @Nullable EntityType type, List<Metadata> metadataList, Metadata metadata) {
|
|
if (!Via.getConfig().isSuppressMetadataErrors() || Via.getManager().isDebug()) {
|
|
Logger logger = Via.getPlatform().getLogger();
|
|
logger.warning("An error occurred with entity metadata handler");
|
|
logger.warning("This is most likely down to one of your plugins sending bad datawatchers. Please test if this occurs without any plugins except ViaVersion before reporting it on GitHub");
|
|
logger.warning("Also make sure that all your plugins are compatible with your server version.");
|
|
logger.warning("Entity type: " + type);
|
|
logger.warning("Indexed meta: " + metadata);
|
|
logger.warning(metadataList.stream().sorted(Comparator.comparingInt(Metadata::id))
|
|
.map(Metadata::toString).collect(Collectors.joining("\n", "Metadata: ", "")));
|
|
e.printStackTrace();
|
|
}
|
|
}
|
|
}
|