Add overloads to UnsafeValues#loadAdvancement

Author: Strokkur424

paper-api/src/main/java/org/bukkit/UnsafeValues.java

@@ -3,10 +3,12 @@
 import com.google.common.collect.Multimap;
 import io.papermc.paper.entity.EntitySerializationFlag;
 import io.papermc.paper.registry.RegistryKey;
+import java.util.List;
+import java.util.Map;
+import net.kyori.adventure.key.Key;
 import org.bukkit.advancement.Advancement;
 import org.bukkit.attribute.Attribute;
 import org.bukkit.attribute.AttributeModifier;
-import org.bukkit.block.Biome;
 import org.bukkit.block.data.BlockData;
 import org.bukkit.damage.DamageSource;
 import org.bukkit.damage.DamageType;
@@ -23,7 +25,6 @@
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
-import java.util.Map;
 
 /**
  * This interface provides value conversions that may be specific to a
@@ -81,7 +82,46 @@ public interface UnsafeValues {
      * @param advancement representation of the advancement
      * @return the loaded advancement or null if an error occurred
      */
-    Advancement loadAdvancement(NamespacedKey key, String advancement);
+    default Advancement loadAdvancement(NamespacedKey key, String advancement) {
+        return loadAdvancement(key, advancement, true);
+    }
+    
+    /**
+     * Load an advancement represented by the specified string into the server.
+     * The advancement format is governed by Minecraft and has no specified
+     * layout.
+     * <br>
+     * It is currently a JSON object, as described by the <a href="https://minecraft.wiki/w/Advancements">Minecraft wiki</a>.
+     * <br>
+     * Loaded advancements will only be stored and persisted across server restarts
+     * and reloads, if the {@code persist} parameter is set to true. 
+     * <br>
+     * Callers should be prepared for {@link Exception} to be thrown.
+     *
+     * @param key the unique advancement key
+     * @param advancement representation of the advancement
+     * @param persist whether to store this advancement in the bukkit datapack for persistence
+     * @return the loaded advancement or null if an error occurred
+     */
+    Advancement loadAdvancement(Key key, String advancement, boolean persist);
+
+    /**
+     * Load multiple advancements represented by the specified strings into the server.
+     * The advancement format is governed by Minecraft and has no specified
+     * layout.
+     * <br>
+     * It is currently a JSON object, as described by the <a href="https://minecraft.wiki/w/Advancements">Minecraft wiki</a>.
+     * <br>
+     * Loaded advancements will only be stored and persisted across server restarts
+     * and reloads, if the {@code persist} parameter is set to true. 
+     * <br>
+     * Callers should be prepared for {@link Exception} to be thrown.
+     *
+     * @param advancements the advancements to register. The key is the unique advancement key and the value is the advancement's JSON representation
+     * @param persist whether to store this advancement in the bukkit datapack for persistence
+     * @return list of all successfully loaded advancements
+     */
+    List<Advancement> loadAdvancements(Map<Key, String> advancements, boolean persist);
 
     /**
      * Delete an advancement which was loaded and saved by

paper-server/src/main/java/org/bukkit/craftbukkit/util/CraftMagicNumbers.java

@@ -2,6 +2,7 @@
 
 import ca.spottedleaf.moonrise.common.PlatformHooks;
 import com.google.common.base.Preconditions;
+import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.Multimap;
 import com.google.common.io.Files;
 import com.google.gson.JsonElement;
@@ -12,6 +13,8 @@
 import com.mojang.logging.LogUtils;
 import com.mojang.serialization.Dynamic;
 import com.mojang.serialization.JsonOps;
+import io.papermc.paper.adventure.PaperAdventure;
+import io.papermc.paper.entity.EntitySerializationFlag;
 import io.papermc.paper.registry.RegistryKey;
 import java.io.File;
 import java.io.IOException;
@@ -25,9 +28,12 @@
 import java.util.Set;
 import java.util.logging.Level;
 import java.util.stream.Stream;
-import io.papermc.paper.entity.EntitySerializationFlag;
+import net.kyori.adventure.key.Key;
 import net.minecraft.SharedConstants;
 import net.minecraft.advancements.AdvancementHolder;
+import net.minecraft.advancements.AdvancementNode;
+import net.minecraft.advancements.AdvancementTree;
+import net.minecraft.advancements.TreeNodePosition;
 import net.minecraft.commands.Commands;
 import net.minecraft.commands.arguments.item.ItemParser;
 import net.minecraft.core.registries.BuiltInRegistries;
@@ -38,6 +44,7 @@
 import net.minecraft.nbt.StringTag;
 import net.minecraft.nbt.Tag;
 import net.minecraft.nbt.TagParser;
+import net.minecraft.resources.RegistryOps;
 import net.minecraft.resources.ResourceLocation;
 import net.minecraft.server.MinecraftServer;
 import net.minecraft.server.level.ServerLevel;
@@ -299,9 +306,9 @@ private static File getBukkitDataPackFolder() {
     }
 
     @Override
-    public Advancement loadAdvancement(NamespacedKey key, String advancement) {
-        Preconditions.checkArgument(Bukkit.getAdvancement(key) == null, "Advancement %s already exists", key);
-        ResourceLocation resourceKey = CraftNamespacedKey.toMinecraft(key);
+    public Advancement loadAdvancement(Key key, String advancement, boolean persist) {
+        ResourceLocation resourceKey = PaperAdventure.asVanilla(key);
+        Preconditions.checkArgument(MinecraftServer.getServer().getAdvancements().get(resourceKey) == null, "Advancement %s already exists", key);
 
         JsonElement jsonelement = JsonParser.parseString(advancement);
         final net.minecraft.resources.RegistryOps<JsonElement> ops = CraftRegistry.getMinecraftRegistry().createSerializationContext(JsonOps.INSTANCE); // Paper - use RegistryOps
@@ -326,30 +333,101 @@ public Advancement loadAdvancement(NamespacedKey key, String advancement) {
                 }
             }
 
-            Advancement bukkit = Bukkit.getAdvancement(key);
-
-            if (bukkit != null) {
-                File file = new File(CraftMagicNumbers.getBukkitDataPackFolder(), "data" + File.separator + key.getNamespace() + File.separator + "advancements" + File.separator + key.getKey() + ".json");
-                file.getParentFile().mkdirs();
+            AdvancementHolder nmsAdvancement = MinecraftServer.getServer().getAdvancements().get(resourceKey);
+            if (nmsAdvancement != null) {
+                if (persist) {
+                    File file = new File(CraftMagicNumbers.getBukkitDataPackFolder(), "data" + File.separator + key.namespace() + File.separator + "advancements" + File.separator + key.value() + ".json");
+                    file.getParentFile().mkdirs();
 
-                try {
-                    Files.write(advancement, file, StandardCharsets.UTF_8);
-                } catch (IOException ex) {
-                    Bukkit.getLogger().log(Level.SEVERE, "Error saving advancement " + key, ex);
+                    try {
+                        Files.write(advancement, file, StandardCharsets.UTF_8);
+                    } catch (IOException ex) {
+                        Bukkit.getLogger().log(Level.SEVERE, "Error saving advancement " + key, ex);
+                    }
                 }
 
                 MinecraftServer.getServer().getPlayerList().getPlayers().forEach(player -> {
                     player.getAdvancements().reload(MinecraftServer.getServer().getAdvancements());
                     player.getAdvancements().flushDirty(player, false);
                 });
 
-                return bukkit;
+                return nmsAdvancement.toBukkit();
             }
         }
 
         return null;
     }
 
+    @Override
+    public List<Advancement> loadAdvancements(final Map<Key, String> advancements, final boolean persist) {
+        for (Map.Entry<Key, String> entry : advancements.entrySet()) {
+            Preconditions.checkArgument(MinecraftServer.getServer().getAdvancements().get(PaperAdventure.asVanilla(entry.getKey())) == null, "Advancement %s already exists", entry.getKey());
+        }
+
+        final List<LoadAdvancementEntry> mappedAdvancements = new ArrayList<>(advancements.size());
+        for (final Map.Entry<Key, String> entry : advancements.entrySet()) {
+            mappedAdvancements.add(new LoadAdvancementEntry(entry.getKey(), entry.getValue(), PaperAdventure.asVanilla(entry.getKey()), JsonParser.parseString(entry.getValue())));
+        }
+
+        final List<Advancement> outAdvancements = new ArrayList<>(mappedAdvancements.size());
+        final ImmutableMap.Builder<ResourceLocation, AdvancementHolder> mapBuilder = ImmutableMap.builder();
+        mapBuilder.putAll(MinecraftServer.getServer().getAdvancements().advancements);
+
+        final RegistryOps<JsonElement> ops = CraftRegistry.getMinecraftRegistry().createSerializationContext(JsonOps.INSTANCE);
+        final List<AdvancementHolder> advancementHolders = new ArrayList<>(mappedAdvancements.size());
+        for (final LoadAdvancementEntry entry : mappedAdvancements) {
+            final net.minecraft.advancements.Advancement advancement = net.minecraft.advancements.Advancement.CODEC.parse(ops, entry.nmsAdvancement()).getOrThrow(JsonParseException::new);
+            if (advancement == null) {
+                continue;
+            }
+
+            final AdvancementHolder holder = new AdvancementHolder(entry.nmsResourceLocation(), advancement);
+            mapBuilder.put(entry.nmsResourceLocation(), holder);
+            advancementHolders.add(holder);
+        }
+
+        MinecraftServer.getServer().getAdvancements().advancements = mapBuilder.build();
+
+        final AdvancementTree tree = MinecraftServer.getServer().getAdvancements().tree();
+        tree.addAll(advancementHolders);
+
+        for (LoadAdvancementEntry entry : mappedAdvancements) {
+            // recalculate advancement position
+            final AdvancementNode node = tree.get(entry.nmsResourceLocation());
+            if (node != null) {
+                final AdvancementNode root = node.root();
+                if (root.holder().value().display().isPresent()) {
+                    TreeNodePosition.run(root);
+                }
+            }
+
+            AdvancementHolder nmsAdvancement = MinecraftServer.getServer().getAdvancements().get(entry.nmsResourceLocation);
+            if (nmsAdvancement != null) {
+                if (persist) {
+                    File file = new File(CraftMagicNumbers.getBukkitDataPackFolder(), "data" + File.separator + entry.key().namespace() + File.separator + "advancements" + File.separator + entry.key().value() + ".json");
+                    file.getParentFile().mkdirs();
+
+                    try {
+                        Files.write(entry.rawAdvancement(), file, StandardCharsets.UTF_8);
+                    } catch (IOException ex) {
+                        Bukkit.getLogger().log(Level.SEVERE, "Error saving advancement " + entry.key(), ex);
+                    }
+                }
+
+                outAdvancements.add(nmsAdvancement.toBukkit());
+            }
+        }
+
+        if (!outAdvancements.isEmpty()) {
+            MinecraftServer.getServer().getPlayerList().getPlayers().forEach(player -> {
+                player.getAdvancements().reload(MinecraftServer.getServer().getAdvancements());
+                player.getAdvancements().flushDirty(player, false);
+            });
+        }
+
+        return outAdvancements;
+    }
+
     @Override
     public boolean removeAdvancement(NamespacedKey key) {
         File file = new File(CraftMagicNumbers.getBukkitDataPackFolder(), "data" + File.separator + key.getNamespace() + File.separator + "advancements" + File.separator + key.getKey() + ".json");
@@ -860,4 +938,6 @@ public io.papermc.paper.plugin.lifecycle.event.LifecycleEventManager<org.bukkit.
     public org.bukkit.inventory.ItemStack createEmptyStack() {
         return CraftItemStack.asCraftMirror(null);
     }
+
+    private record LoadAdvancementEntry(Key key, String rawAdvancement, ResourceLocation nmsResourceLocation, JsonElement nmsAdvancement) {}
 }