diff options
| -rw-r--r-- | README.md | 102 | ||||
| -rw-r--r-- | README_zh_CN.md | 94 | ||||
| -rw-r--r-- | build.gradle | 6 | ||||
| -rw-r--r-- | gradle.properties | 2 | ||||
| -rw-r--r-- | src/main/java/com/keuin/kbackupfabric/KBCommandsRegister.java | 68 | ||||
| -rw-r--r-- | src/main/java/me/lucko/fabric/api/permissions/v0/PermissionCheckEvent.java | 52 | ||||
| -rw-r--r-- | src/main/java/me/lucko/fabric/api/permissions/v0/Permissions.java | 186 |
7 files changed, 454 insertions, 56 deletions
@@ -1,73 +1,96 @@ -# Depreciation Notice (废弃声明) +# 0. README in another language -**This project is DISCONTINUED. Only bug reporting issues will be accepted.** +| Language | File | +|--------------|------------------------------------| +| English (US) | [README.md](README.md) | +| 简体中文 | [README_zh_CN.md](README_zh_CN.md) | -**However, it is still a good choice for single-machine backup.** +# 1. Inactive Development Notice -I decide to discontinue my development in this project. There are some major reasons: +## TL;DR -1. As one of my toy projects, its code quality is not satisfying and refactoring takes too much effort. The git history is bad too. -2. The Mod is proven to be working well (at least the latest version on my server, with Minecraft 1.16.5) as a basic backup and rollback tool for the game. All important features for a backup Mod are implemented. -3. I need a tool which backs up the save to the filesystem on another computer, via network. +- I have no time to keep active development in this project. +- Only bug reporting issues will be accepted. +- So if you want some new features, just clone and work on the code. Note that this project is licensed under GPLv3. -To solve these problems, I'm working on a new backup and rollback tool for Minecraft, which is based on [rdiff-backup](https://github.com/rdiff-backup/rdiff-backup). +**Any PR is welcomed. Feel free to add your reasonable features, if you have written test cases for them.** -As a general incremental backup tool, it tends to be more solid and well-designed. Moreover, it is able to transfer backup files over network. -Thus, I believe it is a good start point to reimplement an incremental backup Mod for Minecraft. +## A longer version -However, this tool is still a good choice for any Minecraft server (from 1.14.4 to 1.17.1) who wants to back up its world locally. +I decided to discontinue my development in this project. There are some major reasons: -(in simplified Chinese) +1. As one of my toy projects, its code quality is not satisfying and refactoring takes too much effort. The git history + is bad too. +2. The Mod is proven to be working well (at least the latest version on my server, with Minecraft 1.16.5) as a basic + backup and rollback tool for the game. All important features for a backup Mod are implemented. +3. I need a tool which backs up the save to the filesystem on another computer, via network. -由于我想实现一个可以将存档备份到网络上另一台计算机上的备份Mod，而如果要给这个项目增加此功能且保证可靠，需要做大量的修改和测试，这个工作量是我无法承受的。 -因此，我打算废弃这个项目，开始基于[rdiff-backup](https://github.com/rdiff-backup/rdiff-backup)开发一个新的备份Mod。 +To solve these problems, I'm working on a new backup and rollback tool for Minecraft, which is based +on [rdiff-backup](https://github.com/rdiff-backup/rdiff-backup). -在新Mod完善之前，这个Mod仍会继续更新，不过只是在修复Bug方面。这个Mod已经持续开发了一年半，基本功能是十分可靠的，因此，如果你只是需要一个将存档 -备份到本地的Mod，那么这仍然是一个可靠的选择。 +As a general incremental backup tool, it tends to be more solid and well-designed. Moreover, it is able to transfer +backup files over network. Thus, I believe it is a good start point to reimplement an incremental backup Mod for +Minecraft. -# KBackup-Fabric +However, this tool is still a good choice for any Minecraft server (from 1.14.4 to 1.17.1) who wants to back up its +world locally. -A simple backup mod for **fabric** Minecraft server, which makes **normal `.zip` backup** of your world, or self-implemented **incremental backup**, with slower increasing disk usage. +# 2. Usages -一个简单的Fabric备份Mod，支持普通备份（将存档整体压缩为 `.zip` 文件，保存在 `backups` 目录下）和增量备份（按需保存到 `incremental` 目录下，并将目录树结构保存在 `backups` 目录下） +A server-only backup mod for **fabric** Minecraft server, which makes **normal `.zip` backup** of your world, or +self-implemented **incremental backup**, with slower increasing disk usage. -Supported Minecraft version: 1.14.4, 1.15.2, 1.16.4/1.16.5 +Supported Minecraft version: 1.14.4, 1.15.2, 1.16.4/1.16.5, 1.17.1, 1.18.1 [Fabric API](https://minecraft.curseforge.com/projects/fabric/files) is required! -## 1. Commands +## 2.1 Commands (In English) - **/kb** or **/kb help**: show command list - **/kb list**: show existing backups - **/kb backup \[backup_name\]**: make a backup with given name or with the current system time by default -- **/kb incbak \[backup_name\]**: make an incremental backup which will be saved in `incremental` folder. (Incremental backup will create an index file which has an ext name of `.kbi`, and it will be saved in `backups` folder, which is the same with where `.zip` resides) +- **/kb incbak \[backup_name\]**: make an incremental backup which will be saved in `incremental` folder. (Incremental + backup will create an index file which has an ext name of `.kbi`, and it will be saved in `backups` folder, which is + the same with where `.zip` resides) - **/kb restore \<backup_name\>**: restore to a certain backup. This command needs a confirmation to execute. - **/kb confirm**: confirm executing restore operation. The operation is irreversible. - **/kb delete**: delete an existing backup. -- **/kb prev**: Find and select the most recent backup file. After executing this command, you can use `/kb restore 1` to restore to this backup. +- **/kb prev**: Find and select the most recent backup file. After executing this command, you can use `/kb restore 1` + to restore to this backup. -(In simplified Chinese, 简体中文版本) +Only OPs can make backups and restore by default. -- **/kb** or **/kb help**: 显示命令列表 -- **/kb list**: 显示所有已有的备份 -- **/kb backup \[backup_name\]**: 以给定名字创建一个新备份，缺省的名字是“noname” -- **/kb incbak \[backup_name\]**: 创建一个增量备份，保存在 `incremental` 目录下。 (增量备份会创建扩展名为`.kbi`的一个索引文件，该文件仍被保存在 `backups` 目录下，与`.zip`文件的保存位置相同) -- **/kb restore \<backup_name\>**: 还原到指定的备份。该命令需要二次确认才会真正被执行 -- **/kb confirm**: 二次确认，一旦确认，等待确认的命令会立刻被执行。这个命令是不可逆的 -- **/kb delete**: 删除一个现有的备份 -- **/kb prev**: 显示并且选中最近的一个备份，执行这个命令后，可以直接使用 `/kb restore 1` 进行还原 +However, you can use permission management mods like [LuckPerms](https://luckperms.net/) to configure exactly what +permissions normal players can use. Permission nodes of each command are listed below: -## 2. Script for auto-restart after restoring +| Command | Permission Required | +|------------|---------------------| +| /kb | kb.root | +| /kb help | kb.help | +| /kb list | kb.list | +| /kb backup | kb.backup | +| /kb incbak | kb.incbak | +| /kb restore | kb.restore | +| /kb delete | kb.delete | +| /kb confirm | kb.confirm | +| /kb cancel | kb.cancel | +| /kb prev | kb.prev | -Due to the nature of JVM: the Java language's running environment, there is no elegant way to restart Minecraft server in a server plugin. In order to auto restart after restoring, an outer system-based script is required, i.e. a batch or a shell script. +## 2.2 Script for auto-restart after restoring -KBackup exit JVM with a special code `111` after restoring the level successfully. The startup script just check the exit code and restart Minecraft server if the code is `111`. +Due to the nature of JVM: the Java language's running environment, there is no elegant way to restart Minecraft server +in a server plugin. In order to auto restart after restoring, an outer system-based script is required, i.e. a batch or +a shell script. -I will give examples for some popular operating systems. To use these scripts, you should replace your start.bat or start.sh script with given code lines. +KBackup exit JVM with a special code `111` after restoring the level successfully. The startup script just check the +exit code and restart Minecraft server if the code is `111`. -### 2.1 Script for Windows +I will give examples for some popular operating systems. To use these scripts, you should replace your start.bat or +start.sh script with given code lines. + +### 2.2.1 Script for Windows ```batch @echo off @@ -79,7 +102,7 @@ rem kbackup restore auto restart pause ``` -### 2.2 Script for Linux or U\*ix using shell (Not tested, I use Windows for the most time, test it on your own) +### 2.2.2 Script for Linux or U\*ix using shell (Not tested, I use Windows for the most time, test it on your own) ```shell #!/bin/sh @@ -91,8 +114,7 @@ do done ``` - -## 3. To-Do List: +# 3. To-Do List - A more friendly help menu (colored command help menu) - New version checker diff --git a/README_zh_CN.md b/README_zh_CN.md new file mode 100644 index 0000000..bbedd1a --- /dev/null +++ b/README_zh_CN.md @@ -0,0 +1,94 @@ +# 0. README in another language + +| Language | File | +|--------------|------------------------------------| +| English (US) | [README.md](README.md) | +| 简体中文 | [README_zh_CN.md](README_zh_CN.md) | + +# 1. 不活跃开发声明 + +## 太长不看版 + +- 我没有时间来保持活跃维护这个项目 +- Issues里，只有反馈BUG的Issue会被我处理（欢迎其他贡献者来维护） +- 如果你想要新功能，请自己实现（注意遵守GPLv3协议） + +**欢迎任何人的PR，放心大胆地添加你的feature，只要它是合理有用的。不过，请给你的新代码写测试。 :)** + +## 长文阅读版 + +由于我想实现一个可以将存档备份到网络上另一台计算机上的备份Mod，而如果要给这个项目增加此功能且保证可靠，需要做大量的修改和测试，这个工作量是我无法承受的。 +因此，我打算废弃这个项目，开始基于[rdiff-backup](https://github.com/rdiff-backup/rdiff-backup)开发一个新的备份Mod。 + +在新Mod完善之前，这个Mod仍会继续更新，不过只是在修复Bug方面。这个Mod已经持续开发了一年半，基本功能是十分可靠的，因此，如果你只是需要一个将存档 备份到本地的Mod，那么这仍然是一个可靠的选择。 + +# 2. 使用说明 + +一个仅服务端的Fabric备份Mod，支持普通备份（将存档整体压缩为 `.zip` 文件，保存在 `backups` 目录下）和增量备份（按需保存到 `incremental` 目录下，并将目录树结构保存在 `backups` 目录下） + +支持的Minecraft版本：1.14.4、1.15.2、1.16.4/1.16.5、1.17.1、1.18.1 + +需要安装[Fabric API](https://minecraft.curseforge.com/projects/fabric/files)模组才可使用！ + +## 2.1 指令列表 + +- **/kb** or **/kb help**: 显示命令列表 +- **/kb list**: 显示所有已有的备份 +- **/kb backup \[backup_name\]**: 以给定名字创建一个新备份，缺省的名字是“noname” +- **/kb incbak \[backup_name\]**: 创建一个增量备份，保存在 `incremental` 目录下。 (增量备份会创建扩展名为`.kbi`的一个索引文件，该文件仍被保存在 `backups` + 目录下，与`.zip`文件的保存位置相同) +- **/kb restore \<backup_name\>**: 还原到指定的备份。该命令需要二次确认才会真正被执行 +- **/kb confirm**: 二次确认，一旦确认，等待确认的命令会立刻被执行。这个命令是不可逆的 +- **/kb delete**: 删除一个现有的备份 +- **/kb prev**: 显示并且选中最近的一个备份，执行这个命令后，可以直接使用 `/kb restore 1` 进行还原 + +默认情况下，只有OP才能备份和回档。 + +如果要详细配置你的玩家可以使用哪些命令，可以用像 [LuckPerms](https://luckperms.net/) 之类的权限管理插件来配置。KBackup的指令权限节点如下表所示： + +| 指令 | 需要的权限 | +|-------------|------------| +| /kb | kb.root | +| /kb help | kb.help | +| /kb list | kb.list | +| /kb backup | kb.backup | +| /kb incbak | kb.incbak | +| /kb restore | kb.restore | +| /kb delete | kb.delete | +| /kb confirm | kb.confirm | +| /kb cancel | kb.cancel | +| /kb prev | kb.prev | + +## 2.2 如何在回档后自动重启服务端 + +受限于JVM自身，MC的模组和插件无法优雅地重启自己。KBackup采取的自动重启方案是： + +- MC服务端被用特殊的启动脚本启动。 +- 回档完成后，MC服务端进程退出，退出代码为特殊值`111`。 +- 启动脚本在MC服务端进程结束后检查返回值。如果是`111`，则重新启动服务端，否则结束脚本。 + +在Windows和Linux下都是可用的，而且POSIX兼容的操作系统应该都可以用。下文将给出Windows和Linux系统的示例脚本（分别为`.bat`批处理脚本和`.sh`外壳脚本）。 + +### 2.2.1 适用于Windows的自动重启脚本 + +```batch +@echo off +title Keuin's personal Minecraft server +:loop +java -Xms4G -Xmx4G -jar fabric-server-launch.jar nogui +if %errorlevel%==111 goto loop +rem kbackup restore auto restart +pause +``` + +### 2.2.2 适用于Linux的自动重启脚本 + +```shell +#!/bin/sh +STATUS=111 +while [ $STATUS -eq 111 ] +do + java -Xms4G -Xmx4G -jar fabric-server-launch.jar nogui + STATUS=$? +done +``` diff --git a/build.gradle b/build.gradle index c71ec07..9efbcd1 100644 --- a/build.gradle +++ b/build.gradle @@ -10,6 +10,12 @@ archivesBaseName = project.archives_base_name version = project.mod_version + "_mc" + project.minecraft_version group = project.maven_group +repositories { + maven { + url 'https://oss.sonatype.org/content/repositories/snapshots' + } +} + dependencies { implementation 'junit:junit:4.12' diff --git a/gradle.properties b/gradle.properties index 08de13e..fe9cb0f 100644 --- a/gradle.properties +++ b/gradle.properties @@ -6,7 +6,7 @@ minecraft_version=1.18.1 yarn_mappings=1.18.1+build.17 loader_version=0.12.12 # Mod Properties -mod_version=1.6.7 +mod_version=1.7.0 maven_group=com.keuin.kbackupfabric archives_base_name=kbackup-fabric # Dependencies diff --git a/src/main/java/com/keuin/kbackupfabric/KBCommandsRegister.java b/src/main/java/com/keuin/kbackupfabric/KBCommandsRegister.java index a27753f..5ec0239 100644 --- a/src/main/java/com/keuin/kbackupfabric/KBCommandsRegister.java +++ b/src/main/java/com/keuin/kbackupfabric/KBCommandsRegister.java @@ -2,9 +2,9 @@ package com.keuin.kbackupfabric; import com.keuin.kbackupfabric.backup.suggestion.BackupNameSuggestionProvider; import com.keuin.kbackupfabric.ui.KBCommands; -import com.keuin.kbackupfabric.util.PermissionValidator; import com.mojang.brigadier.CommandDispatcher; import com.mojang.brigadier.arguments.StringArgumentType; +import me.lucko.fabric.api.permissions.v0.Permissions; import net.minecraft.server.command.CommandManager; import net.minecraft.server.command.ServerCommandSource; @@ -13,36 +13,74 @@ public final class KBCommandsRegister { public static void registerCommands(CommandDispatcher<ServerCommandSource> dispatcher) { // register /kb and /kb help for help menu - dispatcher.register(CommandManager.literal("kb").executes(KBCommands::kb)); - dispatcher.register(CommandManager.literal("kb").then(CommandManager.literal("help").executes(KBCommands::help))); + dispatcher.register(CommandManager.literal("kb") + .requires(Permissions.require("kb.root", true)) + .executes(KBCommands::kb)); + dispatcher.register(CommandManager.literal("kb") + .then(CommandManager.literal("help") + .requires(Permissions.require("kb.help", true)) + .executes(KBCommands::help))); // register /kb list for showing the backup list. OP is required. - dispatcher.register(CommandManager.literal("kb").then(CommandManager.literal("list").requires(PermissionValidator::op).executes(KBCommands::list))); + dispatcher.register(CommandManager.literal("kb") + .then(CommandManager.literal("list") + .requires(Permissions.require("kb.list", 4)) + .executes(KBCommands::list))); // register /kb backup [name] for performing backup. OP is required. dispatcher.register(CommandManager.literal("kb").then(CommandManager.literal("backup").then( - CommandManager.argument("backupName", StringArgumentType.greedyString()).requires(PermissionValidator::op).executes(KBCommands::primitiveBackup) - ).requires(PermissionValidator::op).executes(KBCommands::primitiveBackupWithDefaultName))); + CommandManager.argument("backupName", StringArgumentType.greedyString()) + .requires(Permissions.require("kb.backup", 4)) + .executes(KBCommands::primitiveBackup) + ).requires(Permissions.require("kb.backup", 4)) + .executes(KBCommands::primitiveBackupWithDefaultName))); // register /kb incbak [name] for performing incremental backup. OP is required. - dispatcher.register(CommandManager.literal("kb").then(CommandManager.literal("incbak").then( - CommandManager.argument("backupName", StringArgumentType.greedyString()).requires(PermissionValidator::op).executes(KBCommands::incrementalBackup) - ).requires(PermissionValidator::op).executes(KBCommands::incrementalBackupWithDefaultName))); + dispatcher.register(CommandManager.literal("kb") + .then(CommandManager.literal("incbak") + .then(CommandManager.argument("backupName", StringArgumentType.greedyString()) + .requires(Permissions.require("kb.incbak", 4)) + .executes(KBCommands::incrementalBackup)) + .requires(Permissions.require("kb.incbak", 4)) + .executes(KBCommands::incrementalBackupWithDefaultName) + )); // register /kb restore <name> for performing restore. OP is required. - dispatcher.register(CommandManager.literal("kb").then(CommandManager.literal("restore").then(CommandManager.argument("backupName", StringArgumentType.greedyString()).suggests(BackupNameSuggestionProvider.getProvider()).requires(PermissionValidator::op).executes(KBCommands::restore)).executes(KBCommands::list))); + dispatcher.register(CommandManager.literal("kb") + .then(CommandManager.literal("restore") + .then(CommandManager.argument("backupName", StringArgumentType.greedyString()) + .suggests(BackupNameSuggestionProvider.getProvider()) + .requires(Permissions.require("kb.restore", 4)) + .executes(KBCommands::restore)) + .requires(Permissions.require("kb.list", 4)) + .executes(KBCommands::list))); // register /kb delete [name] for deleting an existing backup. OP is required. - dispatcher.register(CommandManager.literal("kb").then(CommandManager.literal("delete").then(CommandManager.argument("backupName", StringArgumentType.greedyString()).suggests(BackupNameSuggestionProvider.getProvider()).requires(PermissionValidator::op).executes(KBCommands::delete)))); + dispatcher.register(CommandManager.literal("kb") + .then(CommandManager.literal("delete") + .then(CommandManager.argument("backupName", StringArgumentType.greedyString()) + .suggests(BackupNameSuggestionProvider.getProvider()) +// .requires(Permissions.require("kb.delete", 4)) + .executes(KBCommands::delete)) + .requires(Permissions.require("kb.delete", 4)))); // register /kb confirm for confirming the execution. OP is required. - dispatcher.register(CommandManager.literal("kb").then(CommandManager.literal("confirm").requires(PermissionValidator::op).executes(KBCommands::confirm))); + dispatcher.register(CommandManager.literal("kb") + .then(CommandManager.literal("confirm") + .requires(Permissions.require("kb.confirm", 4)) + .executes(KBCommands::confirm))); // register /kb cancel for cancelling the execution to be confirmed. OP is required. - dispatcher.register(CommandManager.literal("kb").then(CommandManager.literal("cancel").requires(PermissionValidator::op).executes(KBCommands::cancel))); + dispatcher.register(CommandManager.literal("kb") + .then(CommandManager.literal("cancel") + .requires(Permissions.require("kb.cancel", 4)) + .executes(KBCommands::cancel))); - // register /kb prev for showing the latest backup. - dispatcher.register(CommandManager.literal("kb").then(CommandManager.literal("prev").requires(PermissionValidator::op).executes(KBCommands::prev))); + // register /kb prev for showing the latest backup. OP is required. + dispatcher.register(CommandManager.literal("kb") + .then(CommandManager.literal("prev") + .requires(Permissions.require("kb.prev", 4)) + .executes(KBCommands::prev))); // // register /kb setMethod for selecting backup method (zip, incremental) // dispatcher.register(CommandManager.literal("kb").then(CommandManager.literal("setMethod").then(CommandManager.argument("backupMethod", StringArgumentType.string()).suggests(BackupMethodSuggestionProvider.getProvider()).requires(PermissionValidator::op).executes(KBCommands::setMethod)))); diff --git a/src/main/java/me/lucko/fabric/api/permissions/v0/PermissionCheckEvent.java b/src/main/java/me/lucko/fabric/api/permissions/v0/PermissionCheckEvent.java new file mode 100644 index 0000000..42b5b63 --- /dev/null +++ b/src/main/java/me/lucko/fabric/api/permissions/v0/PermissionCheckEvent.java @@ -0,0 +1,52 @@ +/* + * This file is part of fabric-permissions-api, licensed under the MIT License. + * + * Copyright (c) lucko (Luck) <[email protected]> + * 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.fabric.api.permissions.v0; + +import net.fabricmc.fabric.api.event.Event; +import net.fabricmc.fabric.api.event.EventFactory; +import net.fabricmc.fabric.api.util.TriState; +import net.minecraft.command.CommandSource; + +import org.jetbrains.annotations.NotNull; + +/** + * Simple permissions check event for {@link CommandSource}s. + */ +public interface PermissionCheckEvent { + + Event<PermissionCheckEvent> EVENT = EventFactory.createArrayBacked(PermissionCheckEvent.class, (callbacks) -> (source, permission) -> { + for (PermissionCheckEvent callback : callbacks) { + TriState state = callback.onPermissionCheck(source, permission); + if (state != TriState.DEFAULT) { + return state; + } + } + return TriState.DEFAULT; + }); + + @NotNull TriState onPermissionCheck(@NotNull CommandSource source, @NotNull String permission); + +} diff --git a/src/main/java/me/lucko/fabric/api/permissions/v0/Permissions.java b/src/main/java/me/lucko/fabric/api/permissions/v0/Permissions.java new file mode 100644 index 0000000..9fab02b --- /dev/null +++ b/src/main/java/me/lucko/fabric/api/permissions/v0/Permissions.java @@ -0,0 +1,186 @@ +/* + * This file is part of fabric-permissions-api, licensed under the MIT License. + * + * Copyright (c) lucko (Luck) <[email protected]> + * 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.fabric.api.permissions.v0; + +import net.fabricmc.fabric.api.util.TriState; +import net.minecraft.command.CommandSource; +import net.minecraft.entity.Entity; +import net.minecraft.server.command.ServerCommandSource; + +import org.jetbrains.annotations.NotNull; + +import java.util.Objects; +import java.util.function.Predicate; + +/** + * A simple permissions API. + */ +public interface Permissions { + + /** + * Gets the {@link TriState state} of a {@code permission} for the given source. + * + * @param source the source + * @param permission the permission + * @return the state of the permission + */ + static @NotNull TriState getPermissionValue(@NotNull CommandSource source, @NotNull String permission) { + Objects.requireNonNull(source, "source"); + Objects.requireNonNull(permission, "permission"); + return PermissionCheckEvent.EVENT.invoker().onPermissionCheck(source, permission); + } + + /** + * Performs a permission check, falling back to the {@code defaultValue} if the resultant + * state is {@link TriState#DEFAULT}. + * + * @param source the source to perform the check for + * @param permission the permission to check + * @param defaultValue the default value to use if nothing has been set + * @return the result of the permission check + */ + static boolean check(@NotNull CommandSource source, @NotNull String permission, boolean defaultValue) { + return getPermissionValue(source, permission).orElse(defaultValue); + } + + /** + * Performs a permission check, falling back to requiring the {@code defaultRequiredLevel} + * if the resultant state is {@link TriState#DEFAULT}. + * + * @param source the source to perform the check for + * @param permission the permission to check + * @param defaultRequiredLevel the required permission level to check for as a fallback + * @return the result of the permission check + */ + static boolean check(@NotNull CommandSource source, @NotNull String permission, int defaultRequiredLevel) { + return getPermissionValue(source, permission).orElseGet(() -> source.hasPermissionLevel(defaultRequiredLevel)); + } + + /** + * Performs a permission check, falling back to {@code false} if the resultant state + * is {@link TriState#DEFAULT}. + * + * @param source the source to perform the check for + * @param permission the permission to check + * @return the result of the permission check + */ + static boolean check(@NotNull CommandSource source, @NotNull String permission) { + return getPermissionValue(source, permission).orElse(false); + } + + /** + * Creates a predicate which returns the result of performing a permission check, + * falling back to the {@code defaultValue} if the resultant state is {@link TriState#DEFAULT}. + * + * @param permission the permission to check + * @param defaultValue the default value to use if nothing has been set + * @return a predicate that will perform the permission check + */ + static @NotNull Predicate<ServerCommandSource> require(@NotNull String permission, boolean defaultValue) { + Objects.requireNonNull(permission, "permission"); + return player -> check(player, permission, defaultValue); + } + + /** + * Creates a predicate which returns the result of performing a permission check, + * falling back to requiring the {@code defaultRequiredLevel} if the resultant state is + * {@link TriState#DEFAULT}. + * + * @param permission the permission to check + * @param defaultRequiredLevel the required permission level to check for as a fallback + * @return a predicate that will perform the permission check + */ + static @NotNull Predicate<ServerCommandSource> require(@NotNull String permission, int defaultRequiredLevel) { + Objects.requireNonNull(permission, "permission"); + return player -> check(player, permission, defaultRequiredLevel); + } + + /** + * Creates a predicate which returns the result of performing a permission check, + * falling back to {@code false} if the resultant state is {@link TriState#DEFAULT}. + * + * @param permission the permission to check + * @return a predicate that will perform the permission check + */ + static @NotNull Predicate<ServerCommandSource> require(@NotNull String permission) { + Objects.requireNonNull(permission, "permission"); + return player -> check(player, permission); + } + + /** + * Gets the {@link TriState state} of a {@code permission} for the given entity. + * + * @param entity the entity + * @param permission the permission + * @return the state of the permission + */ + static @NotNull TriState getPermissionValue(@NotNull Entity entity, @NotNull String permission) { + Objects.requireNonNull(entity, "entity"); + return getPermissionValue(entity.getCommandSource(), permission); + } + + /** + * Performs a permission check, falling back to the {@code defaultValue} if the resultant + * state is {@link TriState#DEFAULT}. + * + * @param entity the entity to perform the check for + * @param permission the permission to check + * @param defaultValue the default value to use if nothing has been set + * @return the result of the permission check + */ + static boolean check(@NotNull Entity entity, @NotNull String permission, boolean defaultValue) { + Objects.requireNonNull(entity, "entity"); + return check(entity.getCommandSource(), permission, defaultValue); + } + + /** + * Performs a permission check, falling back to requiring the {@code defaultRequiredLevel} + * if the resultant state is {@link TriState#DEFAULT}. + * + * @param entity the entity to perform the check for + * @param permission the permission to check + * @param defaultRequiredLevel the required permission level to check for as a fallback + * @return the result of the permission check + */ + static boolean check(@NotNull Entity entity, @NotNull String permission, int defaultRequiredLevel) { + Objects.requireNonNull(entity, "entity"); + return check(entity.getCommandSource(), permission, defaultRequiredLevel); + } + + /** + * Performs a permission check, falling back to {@code false} if the resultant state + * is {@link TriState#DEFAULT}. + * + * @param entity the entity to perform the check for + * @param permission the permission to check + * @return the result of the permission check + */ + static boolean check(@NotNull Entity entity, @NotNull String permission) { + Objects.requireNonNull(entity, "entity"); + return check(entity.getCommandSource(), permission); + } + +} |