|
| 1 | +/* |
| 2 | + * Copyright 2019-present CloudNetService team & contributors |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | + |
| 17 | +package eu.cloudnetservice.modules.npc.impl.platform.bukkit.util; |
| 18 | + |
| 19 | +import com.github.juliarn.npclib.api.protocol.PlatformPacketAdapter; |
| 20 | +import com.github.juliarn.npclib.bukkit.protocol.BukkitProtocolAdapter; |
| 21 | +import com.github.retrooper.packetevents.manager.server.ServerVersion; |
| 22 | +import com.github.retrooper.packetevents.util.PEVersion; |
| 23 | +import eu.cloudnetservice.utils.base.StringUtil; |
| 24 | +import java.lang.invoke.MethodHandles; |
| 25 | +import java.lang.invoke.MethodType; |
| 26 | +import java.util.function.Supplier; |
| 27 | +import lombok.NonNull; |
| 28 | +import org.bukkit.Bukkit; |
| 29 | +import org.bukkit.Server; |
| 30 | +import org.bukkit.World; |
| 31 | +import org.bukkit.entity.Player; |
| 32 | +import org.bukkit.inventory.ItemStack; |
| 33 | +import org.bukkit.plugin.Plugin; |
| 34 | +import org.slf4j.Logger; |
| 35 | +import org.slf4j.LoggerFactory; |
| 36 | + |
| 37 | +public final class BukkitPacketAdapterUtil { |
| 38 | + |
| 39 | + private static final Logger LOGGER = LoggerFactory.getLogger(BukkitPacketAdapterUtil.class); |
| 40 | + |
| 41 | + private static final String SYS_PROP_PACKET_ADAPTER = "cloudnet.npcs.packet-adapter"; |
| 42 | + private static final Supplier<PlatformPacketAdapter<World, Player, ItemStack, Plugin>> PACKET_ADAPTER_HOLDER = |
| 43 | + StableValue.supplier(BukkitPacketAdapterUtil::resolveAdapter); |
| 44 | + |
| 45 | + private BukkitPacketAdapterUtil() { |
| 46 | + throw new UnsupportedOperationException(); |
| 47 | + } |
| 48 | + |
| 49 | + /** |
| 50 | + * Resolves the packet adapter to use, either using a specific override or the Minecraft version of the server. This |
| 51 | + * method lazily initializes the version and always returns the same value after the first invocation. |
| 52 | + * |
| 53 | + * @return the npc packet adapter to use. |
| 54 | + */ |
| 55 | + public static @NonNull PlatformPacketAdapter<World, Player, ItemStack, Plugin> resolve() { |
| 56 | + return PACKET_ADAPTER_HOLDER.get(); |
| 57 | + } |
| 58 | + |
| 59 | + /** |
| 60 | + * Resolves the packet adapter to use, either using a specific override or the Minecraft version of the server. |
| 61 | + * |
| 62 | + * @return the npc packet adapter to use. |
| 63 | + */ |
| 64 | + private static @NonNull PlatformPacketAdapter<World, Player, ItemStack, Plugin> resolveAdapter() { |
| 65 | + var overriddenAdapterName = System.getProperty(SYS_PROP_PACKET_ADAPTER); |
| 66 | + return switch (StringUtil.toLower(overriddenAdapterName)) { |
| 67 | + case "protocollib" -> BukkitProtocolAdapter.protocolLib(); |
| 68 | + case "packetevents" -> BukkitProtocolAdapter.packetEvents(); |
| 69 | + case null, default -> evaluateAdapter(); |
| 70 | + }; |
| 71 | + } |
| 72 | + |
| 73 | + /** |
| 74 | + * Evaluates the packet adapter to use based on the current Minecraft version running on the server. If no reliable |
| 75 | + * guess can be made, this method returns the {@code ProtocolLib} packet adapter implementation. |
| 76 | + * |
| 77 | + * @return the packet adapter to use based on the current Minecraft version running on the server. |
| 78 | + */ |
| 79 | + private static @NonNull PlatformPacketAdapter<World, Player, ItemStack, Plugin> evaluateAdapter() { |
| 80 | + try { |
| 81 | + var minecraftVersion = resolveMinecraftVersion(); |
| 82 | + var parsedMinecraftVersion = PEVersion.fromString(minecraftVersion); |
| 83 | + var latestPeSupportedMinecraftVersion = PEVersion.fromString(ServerVersion.getLatest().getReleaseName()); |
| 84 | + var packetEventsNotSupported = parsedMinecraftVersion.isNewerThan(latestPeSupportedMinecraftVersion); |
| 85 | + return packetEventsNotSupported ? BukkitProtocolAdapter.protocolLib() : BukkitProtocolAdapter.packetEvents(); |
| 86 | + } catch (Exception exception) { |
| 87 | + LOGGER.warn( |
| 88 | + "Failed to reliably determine supported packet adapter ({}: {}), falling back to ProtocolLib", |
| 89 | + exception.getClass().getSimpleName(), exception.getMessage()); |
| 90 | + return BukkitProtocolAdapter.protocolLib(); |
| 91 | + } |
| 92 | + } |
| 93 | + |
| 94 | + /** |
| 95 | + * Resolves the Minecraft version currently running on the server. |
| 96 | + * |
| 97 | + * @return the Minecraft version currently running on the server. |
| 98 | + * @throws RuntimeException if no reliable guess can be made about the running version. |
| 99 | + */ |
| 100 | + private static @NonNull String resolveMinecraftVersion() { |
| 101 | + try { |
| 102 | + var lookup = MethodHandles.publicLookup(); |
| 103 | + var getMinecraftVersion = lookup.findVirtual( |
| 104 | + Server.class, |
| 105 | + "getMinecraftVersion", |
| 106 | + MethodType.methodType(String.class)); |
| 107 | + return (String) getMinecraftVersion.invokeExact(Bukkit.getServer()); |
| 108 | + } catch (Throwable _) { |
| 109 | + var bukkitVersion = Bukkit.getBukkitVersion(); |
| 110 | + var maybeMinecraftVersion = bukkitVersion.split("-", 2)[0]; |
| 111 | + if (maybeMinecraftVersion.indexOf('.') == -1) { |
| 112 | + var msg = String.format( |
| 113 | + "Failed to determine Minecraft version from '%s'. Use the system property '%s' to set a packet adapter", |
| 114 | + bukkitVersion, SYS_PROP_PACKET_ADAPTER); |
| 115 | + throw new RuntimeException(msg); |
| 116 | + } |
| 117 | + |
| 118 | + return maybeMinecraftVersion; |
| 119 | + } |
| 120 | + } |
| 121 | +} |
0 commit comments