From a97bdba0a07bb4427eb15115d25668793979f494 Mon Sep 17 00:00:00 2001 From: lucko Date: Thu, 21 May 2026 21:43:28 +0100 Subject: [PATCH] Implement fabric-permission-api v1 (#4248) --- fabric/build.gradle | 5 +- .../luckperms/fabric/LPFabricPlugin.java | 6 +- ...va => FabricPermissionsApiV0Listener.java} | 4 +- .../FabricPermissionsApiV1Listener.java | 136 ++++++++++++++++++ fabric/src/main/resources/fabric.mod.json | 2 + 5 files changed, 147 insertions(+), 6 deletions(-) rename fabric/src/main/java/me/lucko/luckperms/fabric/listeners/{FabricPermissionsApiListener.java => FabricPermissionsApiV0Listener.java} (98%) create mode 100644 fabric/src/main/java/me/lucko/luckperms/fabric/listeners/FabricPermissionsApiV1Listener.java diff --git a/fabric/build.gradle b/fabric/build.gradle index 1809f6193..1afd2ec4d 100644 --- a/fabric/build.gradle +++ b/fabric/build.gradle @@ -39,11 +39,12 @@ dependencies { 'fabric-command-api-v2', 'fabric-lifecycle-events-v1', 'fabric-networking-api-v1', - 'fabric-entity-events-v1' + 'fabric-entity-events-v1', + 'fabric-permission-api-v1', ] apiModules.forEach { - implementation(fabricApi.module(it, '0.144.0+26.1')) + implementation(fabricApi.module(it, '0.149.0+26.1.2')) } jarInJar 'me.lucko:fabric-permissions-api:0.7.0' diff --git a/fabric/src/main/java/me/lucko/luckperms/fabric/LPFabricPlugin.java b/fabric/src/main/java/me/lucko/luckperms/fabric/LPFabricPlugin.java index ba1f8b2cb..7c184d74b 100644 --- a/fabric/src/main/java/me/lucko/luckperms/fabric/LPFabricPlugin.java +++ b/fabric/src/main/java/me/lucko/luckperms/fabric/LPFabricPlugin.java @@ -38,7 +38,8 @@ import me.lucko.luckperms.fabric.context.FabricContextManager; import me.lucko.luckperms.fabric.context.FabricPlayerCalculator; import me.lucko.luckperms.fabric.listeners.FabricConnectionListener; import me.lucko.luckperms.fabric.listeners.FabricOtherListeners; -import me.lucko.luckperms.fabric.listeners.FabricPermissionsApiListener; +import me.lucko.luckperms.fabric.listeners.FabricPermissionsApiV0Listener; +import me.lucko.luckperms.fabric.listeners.FabricPermissionsApiV1Listener; import me.lucko.luckperms.fabric.listeners.FabricPermissionsListener; import me.lucko.luckperms.fabric.messaging.FabricMessagingFactory; import me.lucko.luckperms.fabric.placeholder.FabricPlaceholderApiIntegration; @@ -66,7 +67,8 @@ public class LPFabricPlugin extends MinecraftLuckPermsPlugin + * Copyright (c) contributors + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +package me.lucko.luckperms.fabric.listeners; + +import com.google.gson.JsonElement; +import com.google.gson.JsonParser; +import com.mojang.serialization.Codec; +import com.mojang.serialization.JsonOps; +import me.lucko.luckperms.common.model.User; +import me.lucko.luckperms.common.verbose.event.CheckOrigin; +import me.lucko.luckperms.fabric.LPFabricPlugin; +import me.lucko.luckperms.fabric.model.MixinUser; +import net.fabricmc.fabric.api.permission.v1.MutablePermissionContext; +import net.fabricmc.fabric.api.permission.v1.PermissionContext; +import net.fabricmc.fabric.api.permission.v1.PermissionEvents; +import net.fabricmc.fabric.api.permission.v1.PermissionNode; +import net.fabricmc.fabric.impl.permission.PermissionContextKey; +import net.minecraft.resources.Identifier; +import net.minecraft.server.MinecraftServer; +import net.minecraft.world.entity.Entity; + +import java.util.UUID; +import java.util.concurrent.CompletableFuture; +import java.util.function.Consumer; + +/** + * Listener to route permission checks made via fabric-permission-api v1 to LuckPerms. + */ +@SuppressWarnings("UnstableApiUsage") +public class FabricPermissionsApiV1Listener { + private static final PermissionContext.Key USER_KEY = new PermissionContextKey<>(Identifier.fromNamespaceAndPath("luckperms", "user")); + + private final LPFabricPlugin plugin; + + public FabricPermissionsApiV1Listener(LPFabricPlugin plugin) { + this.plugin = plugin; + } + + public void registerListeners() { + PermissionEvents.ON_REQUEST.register(this::onPermissionRequest); + PermissionEvents.PREPARE_OFFLINE_PLAYER.register(this::onPrepareOfflinePlayer); + } + + private T onPermissionRequest(PermissionContext ctx, PermissionNode node) { + Codec codec = node.codec(); + + if (codec == Codec.BOOL) { + // permission check + String permissionString = node.key().getNamespace() + '.' + node.key().getPath(); + Boolean permissionValue = permissionCheck(ctx, permissionString); + return node.cast(permissionValue); + } + + // assume anything non-boolean is an option lookup + String optionKey = node.key().toString(); + String optionValue = optionCheck(ctx, optionKey); + if (optionValue == null) { + return null; + } + + if (codec == Codec.STRING) { + return node.cast(optionValue); + } + if (codec == Codec.INT) { + return node.cast(Integer.parseInt(optionValue)); + } + + // attempt parse with JsonParser & JsonOps + JsonElement element = JsonParser.parseString(optionValue); + return codec.parse(JsonOps.INSTANCE, element).getOrThrow(); + } + + private CompletableFuture> onPrepareOfflinePlayer(PermissionContext ctx, MinecraftServer server) { + UUID uniqueId = ctx.uuid(); + String username = ctx.get(PermissionContextKey.NAME); + + return this.plugin.getStorage().loadUser(uniqueId, username).thenApply(user -> { + if (user == null) { + return null; + } + return mutableCtx -> mutableCtx.set(USER_KEY, user); + }); + } + + private static Boolean permissionCheck(PermissionContext ctx, String permission) { + Entity entity = ctx.get(PermissionContextKey.ENTITY); + if (entity instanceof MixinUser user) { + return user.luckperms$hasPermission(permission).asBoolean(); + } + + User user = ctx.get(USER_KEY); + if (user != null) { + return user.getCachedData().getPermissionData().checkPermission(permission, CheckOrigin.PLATFORM_API_HAS_PERMISSION).result().asBoolean(); + } + + return null; + } + + private static String optionCheck(PermissionContext ctx, String optionKey) { + Entity entity = ctx.get(PermissionContextKey.ENTITY); + if (entity instanceof MixinUser user) { + return user.luckperms$getOption(optionKey); + } + + User user = ctx.get(USER_KEY); + if (user != null) { + return user.getCachedData().getMetaData().getMetaOrChatMetaValue(optionKey, CheckOrigin.PLATFORM_API); + } + + return null; + } + +} diff --git a/fabric/src/main/resources/fabric.mod.json b/fabric/src/main/resources/fabric.mod.json index 1f21cb42f..87a2d2c5c 100644 --- a/fabric/src/main/resources/fabric.mod.json +++ b/fabric/src/main/resources/fabric.mod.json @@ -36,6 +36,8 @@ "fabric-command-api-v2": "*", "fabric-lifecycle-events-v1": "*", "fabric-networking-api-v1": "*", + "fabric-entity-events-v1": "*", + "fabric-permission-api-v1": "*", "fabric-permissions-api-v0": ">=0.7.0" }, "custom": {