allow apps define their own command permission level, fixes #542

docs/scarpet/api/Overview.md

@@ -38,10 +38,9 @@ To access global/server state for a player app, which you shouldn't do, you need
 so either use a command block, or any 
 arbitrary entity: `/execute as @e[type=bat,limit=1] run script in <app> globals` for instance, however
 running anything in the global scope for a `'player'` scoped app is not intended.
-*   `'stay_loaded'`: defaults to `false`. If true, and `/carpet scriptsAutoload` is turned on, the following apps will 
+*   `'stay_loaded'`: defaults to `true`. If true, and `/carpet scriptsAutoload` is turned on, the following apps will 
 stay loaded after startup. Otherwise, after reading the app the first time, and fetching the config, server will drop them down. 
-This is to allow to store multiple apps on the server/world and selectively decide which one should be running at 
-startup. WARNING: all apps will run once at startup anyways, so be aware that their actions that are called 
+ WARNING: all apps will run once at startup anyways, so be aware that their actions that are called 
 statically, will be performed once anyways. Only apps present in the world's `scripts` folder will be autoloaded.
 *   `'legacy_command_type_support'` - if `true`, and the app defines the legacy command system via `__command()` function,
 all parameters of command functions will be interpreted and used using brigadier / vanilla style argument parser and their type
@@ -52,9 +51,20 @@ conflicts and ambiguities between different paths of execution. While ambiguous
 and they tend to execute correctly, the suggestion support works really poorly in these situations and scarpet
 will warn and prevent such apps from loading with an error message. If `allow_command_conflicts` is specified and 
 `true`, then scarpet will load all provided commands regardless.
+*   `'command_permission'` - indicates a custom permission to run the command. It can either be a number indicating 
+permission level (from 1 to 4) or a string value, one of: `'all'` (default), `'ops'` (default opped player with permission level of 2),
+`'server'` - command accessible only through the server console and commandblocks, but not in chat, `'players'` - opposite
+of the former, allowing only use in player chat. It can also be a function (lambda function or function value, not function name)
+that takes 1 parameter, which represents the calling player, or `'null'` if the command represents a server call. 
+The function will prevent the command from running if it evaluates to `false`.
+Please note, that Minecraft evaluates eligible commands for players when they join, or on reload/restart, so if you use a 
+predicate that is volatile and might change, the command might falsely do or do not indicate that it is available to the player,
+however player will always be able to type it in and either succeed, or fail, based on their current permissions.
+Custom permission applies to legacy commands with `'legacy_command_type_support'` as well
+as for the custom commands defined with `'commands'`, see below.
 *   `'arguments'` - defines custom argument types for legacy commands with `'legacy_command_type_support'` as well
-as for the custom commands defined with `'commands'`, see below
-*   `'commands'` - defines custom commands for the app to be executed with `/<app>` command, see below
+as for the custom commands defined with `'commands'`, see below.
+*   `'commands'` - defines custom commands for the app to be executed with `/<app>` command, see below.
 
 ## Custom app commands
 

src/main/java/carpet/script/CarpetScriptHost.java

@@ -11,6 +11,7 @@ import carpet.script.exception.CarpetExpressionException;
 import carpet.script.exception.ExpressionException;
 import carpet.script.exception.InternalExpressionException;
 import carpet.script.exception.InvalidCallbackException;
+import carpet.script.value.EntityValue;
 import carpet.script.value.FunctionValue;
 import carpet.script.value.MapValue;
 import carpet.script.value.NumericValue;
@@ -38,6 +39,7 @@ import java.util.Collections;
 import java.util.Comparator;
 import java.util.HashMap;
 import java.util.List;
+import java.util.Locale;
 import java.util.Map;
 import java.util.function.Function;
 import java.util.stream.Collectors;
@@ -163,8 +165,9 @@ public class CarpetScriptHost extends ScriptHost
     ) throws CommandSyntaxException
     {
         String hostName = main.getName();
+        Function<ServerCommandSource, Boolean> configValidator = getCommandConfigPermissions();
         LiteralArgumentBuilder<ServerCommandSource> command = literal(hostName).
-               requires((player) -> CarpetServer.scriptServer.modules.containsKey(hostName) && useValidator.apply(player));
+               requires((player) -> CarpetServer.scriptServer.modules.containsKey(hostName) && useValidator.apply(player) && configValidator.apply(player));
         for (Pair<List<CommandToken>,FunctionArgument<Value>> commandData : entries)
         {
             command = this.addPathToCommand(command, commandData.getKey(), commandData.getValue());
@@ -172,6 +175,49 @@ public class CarpetScriptHost extends ScriptHost
         return command;
     }
 
+    public Function<ServerCommandSource, Boolean> getCommandConfigPermissions() throws CommandSyntaxException
+    {
+        Value confValue = appConfig.get(StringValue.of("command_permission"));
+        if (confValue == null) return s -> true;
+        if (confValue instanceof NumericValue)
+        {
+            int level = ((NumericValue) confValue).getInt();
+            if (level < 1 || level > 4) throw CommandArgument.error("Numeric permission level for custom commands should be between 1 and 4");
+            return s -> s.hasPermissionLevel(level);
+        }
+        if (!(confValue instanceof FunctionValue))
+        {
+            String perm = confValue.getString().toLowerCase(Locale.ROOT);
+            switch (perm)
+            {
+                case "ops": return s -> s.hasPermissionLevel(2);
+                case "server": return s -> !(s.getEntity() instanceof ServerPlayerEntity);
+                case "players": return s -> s.getEntity() instanceof ServerPlayerEntity;
+                case "all": return s -> true;
+                default: throw CommandArgument.error("Unknown command permission: "+perm);
+            }
+        }
+        FunctionValue fun = (FunctionValue) confValue;
+        if (fun.getNumParams() != 1) throw CommandArgument.error("Custom command permission function should expect 1 argument");
+        String hostName = getName();
+        return s -> {
+            try
+            {
+                CarpetScriptHost cHost = null;
+                cHost = CarpetServer.scriptServer.modules.get(hostName).retrieveOwnForExecution(s);
+                Value response = cHost.handleCommand(s, fun, Collections.singletonList(
+                        (s.getEntity() instanceof ServerPlayerEntity)?new EntityValue(s.getEntity()):Value.NULL)
+                );
+                return response.getBoolean();
+            }
+            catch (CommandSyntaxException e)
+            {
+                Messenger.m(s, "rb Unable to run app command: "+e.getMessage());
+                return false;
+            }
+        };
+    }
+
     @Override
     protected ScriptHost duplicate()
     {

src/main/java/carpet/script/CarpetScriptServer.java

@@ -221,7 +221,6 @@ public class CarpetScriptServer
     public boolean addScriptHost(ServerCommandSource source, String name, Function<ServerCommandSource, Boolean> commandValidator,
                                  boolean perPlayer, boolean autoload, boolean isRuleApp)
     {
-        //TODO add per player modules to support player actions better on a server
         if (commandValidator == null) commandValidator = p -> true;
         long start = System.nanoTime();
         name = name.toLowerCase(Locale.ROOT);
@@ -325,8 +324,19 @@ public class CarpetScriptServer
             return true;
         }
 
+        Function<ServerCommandSource, Boolean> configValidator;
+        try
+        {
+            configValidator = host.getCommandConfigPermissions();
+        }
+        catch (CommandSyntaxException e)
+        {
+            Messenger.m(source, "rb "+e.getMessage());
+            return false;
+        }
+
         LiteralArgumentBuilder<ServerCommandSource> command = literal(hostName).
-                requires((player) -> modules.containsKey(hostName) && useValidator.apply(player)).
+                requires((player) -> modules.containsKey(hostName) && useValidator.apply(player) && configValidator.apply(player)).
                 executes( (c) ->
                 {
                     CarpetScriptHost targetHost = modules.get(hostName).retrieveOwnForExecution(c.getSource());