minecraft: Move commands over to cloud library

This brings brigadier compatibility and a nice help menu

Author: zml2008

api/src/main/java/ca/stellardrift/permissionsex/exception/PermissionsException.java

@@ -19,6 +19,7 @@
 import net.kyori.adventure.text.Component;
 import net.kyori.adventure.text.serializer.plain.PlainComponentSerializer;
 import net.kyori.adventure.translation.GlobalTranslator;
+import net.kyori.adventure.util.ComponentMessageThrowable;
 import org.checkerframework.checker.nullness.qual.Nullable;
 
 import java.util.Locale;
@@ -28,7 +29,7 @@
  *
  * @since 2.0.0
  */
-public class PermissionsException extends Exception {
+public class PermissionsException extends Exception implements ComponentMessageThrowable {
     private static final long serialVersionUID = 138001301588644173L;
     private static final Component NULL = Component.text("null");
 
@@ -53,11 +54,12 @@ public String getLocalizedMessage() {
         return getLocalizedMessage(Locale.getDefault());
     }
 
-    public Component getComponent() {
+    @Override
+    public Component componentMessage() {
         return this.message == null ? NULL : this.message;
     }
 
     public String getLocalizedMessage(Locale locale) {
-        return PlainComponentSerializer.plain().serialize(GlobalTranslator.renderer().render(getComponent(), locale));
+        return PlainComponentSerializer.plain().serialize(GlobalTranslator.renderer().render(componentMessage(), locale));
     }
 }

buildSrc/src/main/kotlin/pex-platform.gradle.kts

@@ -21,6 +21,7 @@ val shadowJar = tasks.named("shadowJar", ShadowJar::class) {
     // Caffeine reflectively accesses some of its cache implementations, so it can't be minimized
     minimize {
         exclude(dependency("com.github.ben-manes.caffeine:.*:.*"))
+        exclude(project(":datastore:sql"))
     }
 
     // Don't shade compile-only annotations, or other project's module info files

core/src/main/java/ca/stellardrift/permissionsex/impl/util/PCollections.java

@@ -201,6 +201,7 @@ public static <E> PSet<E> set(final E element) {
         return HashTreePSet.singleton(element);
     }
 
+    @SafeVarargs
     public static <E> PSet<E> set(final E... elements) {
         PSet<E> out = set();
         for (final E element : elements) {
@@ -217,6 +218,7 @@ public static <E> PVector<E> vector(final E element) {
         return TreePVector.singleton(element);
     }
 
+    @SafeVarargs
     public static <E> PVector<E> vector(final E... elements) {
         PVector<E> out = vector();
         for (final E element : elements) {
@@ -233,6 +235,7 @@ public static <E> PStack<E> stack(final E element) {
         return ConsPStack.singleton(element);
     }
 
+    @SafeVarargs
     public static <E> PStack<E> stack(final E... elements) {
         PStack<E> out = stack();
         for (final E element : elements) {

core/src/main/kotlin/ca/stellardrift/permissionsex/util/TextExtensions.kt

@@ -16,7 +16,6 @@
  */
 package ca.stellardrift.permissionsex.util
 
-import ca.stellardrift.permissionsex.context.ContextValue
 import java.text.MessageFormat
 import java.util.Locale
 import java.util.ResourceBundle
@@ -27,7 +26,6 @@ import net.kyori.adventure.text.Component.space
 import net.kyori.adventure.text.ComponentBuilder
 import net.kyori.adventure.text.ComponentLike
 import net.kyori.adventure.text.TextComponent
-import net.kyori.adventure.text.format.NamedTextColor
 import net.kyori.adventure.text.format.Style
 import net.kyori.adventure.text.format.Style.style
 import net.kyori.adventure.text.format.TextColor
@@ -45,11 +43,12 @@ fun Any?.toComponent(): Component {
 }
 
 fun Boolean.toComponent(): Component {
-    return if (this) {
+    return +this.toString()
+    /*return if (this) {
         Messages.FORMATTER_BOOLEAN_TRUE.bTr().color(NamedTextColor.GREEN)
     } else {
         Messages.FORMATTER_BOOLEAN_FALSE.bTr().color(NamedTextColor.RED)
-    }.build()
+    }.build()*/
 }
 operator fun Boolean.unaryPlus() = this.toComponent()
 
@@ -98,14 +97,6 @@ operator fun <C : BuildableComponent<C, B>, B : ComponentBuilder<C, B>> B.plusAs
 
 // -- PEX-Specific
 
-fun Set<ContextValue<*>>.toComponent(): Component {
-    return if (isEmpty()) {
-        Messages.COMMON_ARGS_CONTEXT_GLOBAL.tr()
-    } else {
-        +toString()
-    }
-}
-
 object PEXComponentRenderer : TranslatableComponentRenderer<Locale>() {
     override fun translate(key: String, context: Locale): MessageFormat {
         val idx = key.indexOf("/")

core/src/main/messages/ca/stellardrift/permissionsex/impl/commands/messages.properties

@@ -123,12 +123,6 @@ delete.error.does-not-exist=Subject {0} does not exist!
 delete.success=Successfully deleted data for subject {0}
 
 
-command.arg-type.callback-id=An ID of a registered callback
-
-command.callback.description=Execute a callback. This command is usually not run manually.
-command.callback.arg.callback-id=id
-command.callback.error.unknown-id=Unknown callback identifier {0}
-command.callback.error.only-own-allowed=You can only activate your own callbacks!
 
 
 

doc/2.0-home.md

@@ -4,7 +4,7 @@ This section contains documentation about the new 2.0 release of PermissionsEx.
 
 Just getting started? You'll want to work through the [tutorial](tutorial.md).
 
-Coming from PermissionsEx v1? Take a look at the list of [changes in v2](https://github.com/PEXPlugins/PermissionsEx/tree/b8c6b5a57be63ae79911cb56dc5cc0df510bbe06/doc/changes-in-2.0.md), and the [new commands](https://github.com/PEXPlugins/PermissionsEx/tree/b8c6b5a57be63ae79911cb56dc5cc0df510bbe06/doc/command-equivalency.md).
+Coming from PermissionsEx v1? Take a look at the list of [changes in v2](learning-v2-from-other-plugins-and-v1/changes-in-2.0.md), and the [new commands](components-in-detail/command.md).
 
 Take a look at the contents in sidebar for more information!
 

doc/SUMMARY.md

@@ -2,6 +2,7 @@
 
 * [Home](2.0-home.md)
 * [Getting Started](tutorial.md)
+* [Commands](components-in-detail/command.md)  
 * [Components in Detail](components-in-detail/README.md)
   * [Subject](components-in-detail/subject.md)
   * [Defaults and Fallbacks](components-in-detail/defaults-and-fallbacks.md)

doc/components-in-detail/command.md

@@ -0,0 +1,173 @@
+# Commands
+
+PermissionsEx can be configured in-game using its set of commands:
+
+## Argument types
+
+- *subject type*: a type of subject
+- *subject*: A compound argument of subject type and identifier
+- *context*: A `<context-type>=<context-value>` 
+- *rank-ladder*: The name of a currently existing rank ladder
+- *permission*: A permission string
+- *option*: An option string
+- *permission value*: a number, boolean, or `none`, `null`, or `unset`
+
+
+## Common flags
+
+These flags can be specified after any permissions modification command to control the specific areas permissions are updated in:
+
+- `--transient`: If the data should be stored transiently (i.e. only for the current session)
+- `--context <context>`: A context to restrict a permission to, such as a world
+
+## The actual commands
+
+### `/pex|permissionsex`
+
+**Description:** Provides simple information about PermissionsEx.
+
+### `/pex|permissionsex help [command]`
+
+**Description:** Provide help about PermissionsEx commands
+
+**Permission:** `permissionsex.help`
+
+Provides an in-game help viewer for information on PermissionsEx commands
+
+### `/pex|permissionsex debug|d [filter]`
+
+**Description:** Toggle whether all permissions checks are logged to console
+
+**Permission:** `permissionsex.debug`
+
+When enabled, any check executed through PermissionsEx will be logged to console. If the `filter`
+regular expression is provided, only permissions, objects, and parent names that match the pattern will be logged.
+
+### `/pex|permissionsex import [source data store]`
+
+**Description:** Import data from another data store
+
+**Permission:** `permissionsex.import`
+
+Import permissions data from a configured backend, or automatically configured conversion provider.
+If no data store is specified, a list of available sources will be provided.
+
+This import will fully replace any subject in the active data store that is also present in the source data store
+
+### `/pex|permissionsex ranking|rank [ladder]`
+
+**Description:** Print the contents of a rank ladder
+
+**Permission:** `permissionsex.rank.view.<ladder>`
+
+Clickable buttons are added to ease working with rank ladders.
+
+### `/pex|permissionsex ranking|rank <ladder> add|+ <subject> [position] [-r|--relative]`
+
+**Description:** Add a subject to the rank ladder
+
+**Permission:** `permissionsex.rank.add.<ladder>`
+
+Adds a subject to the rank ladder, by default at the end of the ladder. If a position is specified,
+the rank will be inserted at that position. If the rank is already on the ladder and the `--relative`
+flag is provided, the rank will be moved by the specified number of positions.
+
+### `/pex|permissionsex ranking|rank <ladder> remove|rem|- <subject>`
+
+**Description:** Remove a subject from a rank ladder.
+
+**Permission:** `permissionsex.rank.remove.<ladder>`
+
+Remove a subject from a rank ladder.
+
+### `/pex|permissionsex reload|rel`
+
+**Description:** Reload all PermissionsEx configuration
+
+**Permission:** `permissionsex.reload`
+
+Reloads all permissions data. The reload is performed asynchronously, and new data will only be
+applied if the reload is successful.
+
+### `/pex|permissionsex version [--verbose|-v]`
+
+**Description**: Provide information on the current PermissionsEx version.
+
+**Permission:** `permissionsex.version`
+
+Print detailed information on the version of PermissionsEx that is currently running. If
+the `verbose` option is provided, more detailed information on base directories will be printed.
+
+### `/pex|permissionsex <type> <subject> delete [--transient|-t]`
+
+**Description:**: Delete all data for a subject
+
+**Permission:** `permissionsex.delete.<type>.<subject>`
+
+### `/pex|permissionsex <type> <subject> info`
+
+**Description:**: Print all known information for a certain subject.
+
+**Permission:** `permissionsex.info.<type>.<subject>`
+
+All information will be printed for the subject
+
+### `/pex|permissionsex <type> <subject> option|options|opt|o|meta <key> [value] [--transient|-t] [--context key=value]`
+
+**Description:**: Sets or unsets an option for the subject
+
+**Permission:** `permissionsex.option.set.<type>.<subject>`
+
+Sets (if `value` is provided) or unset (if not provided) a certain option on the subject.
+
+### `/pex|permissionsex <type> <subject> parents|parent|par|p add|a|+ <type> <subject> [--transient|t] [--context key=value]`
+
+**Description:**: Adds a parent to the subject
+
+**Permission:** `permissionsex.parent.add.<type>.<subject>`
+
+The parent will be added at the first position to the subject, meaning it will take priority over other parents.
+
+### `/pex|permissionsex <type> <subject> parents|parent|par|p remove|rem|delete|del|- <type> <subject> [--transient|t] [--context key=value]`
+
+**Description:**: Adds a parent to the subject
+
+**Permission:** `permissionsex.parent.remove.<type>.<subject>`
+
+Remove the specified parent from the subject.
+
+### `/pex|permissionsex <type> <subject> parents|parent|par|p remove|rem|delete|del|- <type> <subject> [--transient|t] [--context key=value...]`
+
+**Description:**: Replace all parents of the subject with one parent.
+
+**Permission:** `permissionsex.parent.set.<type>.<subject>`
+
+Remove all parents from the subject and replace them with the one provided subject.
+
+### `/pex|permissionsex <type> <subject> permission|permissions|perm|perms|p <permission> <value> [--transient|t] [--context key=value...]`
+
+**Description:**: Set the permission for a subject
+
+**Permission:** `permissionsex.permission.set.<type>.<subject>`
+
+Set a permission on the subject.
+
+Permission values can be a true or false value to explicitly set the permission, `none`, `null`, or `unset` to clear 
+the permission, or a number to assign a weight to the permission.
+
+- Prefixing a permission with `#` means that its value will only be applicable to a subject and its direct parents.
+- Glob syntax will be evaluated for permissions:
+  - `permissionsex.{permission,parent}.set` will evaluate to both `permissionsex.permission.set` and `permissionsex.parent.set`
+  - `some.permission[a-z]` will match `some.permissiona`, `some.permissionb`, and so on, all the way through until `some.permissionz`
+  
+### `/pex|permissionsex <type> <subject> permission-default|perms-def|permsdef|pdef|pd|default|def <value> [--transient|t] [--context key=value...]`
+
+**Description:**: Set the fallback permission value for a subject
+
+**Permission:** `permissionsex.permission.set-default.<type>.<subject>`
+
+Set the default permissions value for a subject. This is the result that is returned for a subject 
+when no more specific node matches.
+
+This value is roughly equivalent to the `*` permission formerly used, but will not override 
+permissions specifically set to `false`.

doc/contributing/commands-api.md

@@ -14,5 +14,5 @@ An eventual goal is to allow overriding messages using files in the plugin data
 
 While we eventually plan to put up a CrowdIn page to allow translations to be contributed more easily, the only way to contribute at the moment is to provide new versions of the files in the `src/main/messages` folder in each module.
 
-Feel free to ask for help in the Discord -- we will be happy to assist in getting more localizations in
+Feel free to ask for help in the Discord -- we will be happy to assist in getting more localizations in.
 

doc/contributing/localization.md

@@ -30,6 +30,7 @@ adventurePlatformVersion=4.0.0-SNAPSHOT
 antlrVersion=4.9
 autoServiceVersion=1.0-rc7
 checkerVersion=3.7.1
+cloudVersion=1.3.0
 configurateVersion=4.0.0
 errorproneVersion=2.4.0
 immutablesVersion=2.8.8

gradle.properties

@@ -24,14 +24,17 @@ plugins {
 
 useImmutables()
 dependencies {
+    val cloudVersion: String by project
     val immutablesVersion: String by project
 
     api(project(":api"))
     api(project(":core"))
     implementation(adventure("text-serializer-plain"))
     compileOnlyApi("org.immutables:gson:$immutablesVersion")
     implementation("io.projectreactor:reactor-core:3.4.0")
-    implementation(project(":datastore:sql")) // todo: once core deps are extracted, this module should be a dep of core
+    runtimeOnly(project(":datastore:sql"))
+    api("cloud.commandframework:cloud-core:$cloudVersion")
+    implementation("cloud.commandframework:cloud-minecraft-extras:$cloudVersion")
 
     // Fixed version to line up with MC
     implementation("com.google.code.gson:gson:2.8.0")