Command rework (SubnauticaNitrox#1047)

* Rework abstraction of server Command

* Args dynamic read

* Cleanup

* Code style cleanup

* Made it work again

* Renamed Perform method in commands to Execute

* Added whois cmd + Crop help command IG for readability

* DisableAutoSave persisted in config + more cleanup

* some review changes

* Removed unused DefaultValue

* Used subclass for command args so that command class' state doesn't change

* Cleaned up some commands implementations

* Changed GetOverflowArgs to GetTillEnd

* more cleanup

Co-authored-by: Measurity <measuring.infinity@gmail.com>

Author: dartasen

NitroxModel/Server/ServerConfig.cs

@@ -7,28 +7,31 @@ namespace NitroxModel.Server
 {
     public class ServerConfig
     {
-        private readonly ServerConfigItem<bool> disableConsoleSetting;
+        private readonly ServerConfigItem<bool> disableConsoleSetting, disableAutoSaveSetting;
         private readonly ServerConfigItem<int> portSetting, saveIntervalSetting, maxConnectionsSetting;
         private readonly ServerConfigItem<string> saveNameSetting, serverPasswordSetting, adminPasswordSetting, gameModeSetting;
         private readonly ServerConfigItem<float> oxygenSetting, maxOxygenSetting, healthSetting, foodSetting, waterSetting, infectionSetting;
 
-        public ServerConfig(): this(
+        public ServerConfig() : this(
                port: 1100,
-               saveinterval: 60000,
+               saveinterval: 120000,
                maxconnection: 100,
                disableconsole: false,
+               disableautosave: false,
                savename: "world",
                serverpassword: string.Empty,
                adminpassword: StringHelper.GenerateRandomString(12),
                gamemodeSetting: ServerGameMode.SURVIVAL
-        ) { }
+        )
+        { }
 
-        public ServerConfig(int port, int saveinterval, int maxconnection, bool disableconsole, string savename, string serverpassword, string adminpassword, ServerGameMode gamemodeSetting)
+        public ServerConfig(int port, int saveinterval, int maxconnection, bool disableconsole, bool disableautosave, string savename, string serverpassword, string adminpassword, ServerGameMode gamemodeSetting)
         {
             portSetting = new ServerConfigItem<int>("Port", port);
             saveIntervalSetting = new ServerConfigItem<int>("SaveInterval", saveinterval);
             maxConnectionsSetting = new ServerConfigItem<int>("MaxConnections", maxconnection);
             disableConsoleSetting = new ServerConfigItem<bool>("DisableConsole", disableconsole);
+            disableAutoSaveSetting = new ServerConfigItem<bool>("DisableAutoSave", disableautosave);
             saveNameSetting = new ServerConfigItem<string>("SaveName", savename);
             serverPasswordSetting = new ServerConfigItem<string>("ServerPassword", serverpassword);
             adminPasswordSetting = new ServerConfigItem<string>("AdminPassword", adminpassword);
@@ -97,6 +100,19 @@ public bool DisableConsole
             {
                 disableConsoleSetting.Value = value;
             }
+        }     
+        
+        public bool DisableAutoSave
+        {
+            get
+            {
+                return disableAutoSaveSetting.Value;
+            }
+
+            set
+            {
+                disableAutoSaveSetting.Value = value;
+            }
         }
 
         public string SaveName
@@ -156,6 +172,13 @@ public string GameMode
             }
         }
 
+        public ServerGameMode GameModeEnum
+        {
+            set
+            {
+                GameMode = value.GetAttribute<DescriptionAttribute>().Description.ToString();
+            }
+        }
 
         public PlayerStatsData DefaultPlayerStats => new PlayerStatsData(oxygenSetting.Value, maxOxygenSetting.Value, healthSetting.Value, foodSetting.Value, waterSetting.Value, infectionSetting.Value);
         #endregion

NitroxServer-Subnautica/App.config

@@ -3,9 +3,10 @@
     <appSettings>
         <add key="MaxConnections" value="100" />
         <add key="Port" value="11000" />
-        <add key="SaveInterval" value="60000" />
+        <add key="SaveInterval" value="120000" />
         <add key="GameMode" value="Survival" />
         <add key="DisableConsole" value="false" />
+        <add key="DisableAutoSave" value="false" />
         <add key="ServerPassword" value="" />
         <add key="AdminPassword" value="" />
         <add key="SaveName" value="world" />

NitroxServer-Subnautica/SubnauticaServerAutoFacRegistrar.cs

@@ -43,7 +43,6 @@ public override void RegisterDependencies(ContainerBuilder containerBuilder)
                 [TechType.CrashHome.Model()] = new CrashFishBootstrapper(),
                 [TechType.Reefback.Model()] = new ReefbackBootstrapper()
             }).SingleInstance();
-
         }
     }
 }

NitroxServer/Communication/Packets/Processors/ServerCommandProcessor.cs

@@ -17,7 +17,7 @@ public ServerCommandProcessor(ConsoleCommandProcessor cmdProcessor)
 
         public override void Process(ServerCommand packet, Player player)
         {
-            Log.Info($"{player.Name} issued server command: /{packet.Cmd}");
+            Log.Info($"{player.Name} issued command: /{packet.Cmd}");
             cmdProcessor.ProcessCommand(packet.Cmd, Optional.Of(player), player.Permissions);
         }
     }

NitroxServer/ConsoleCommands/Abstract/CallArgs.cs

@@ -0,0 +1,62 @@
+using System.Linq;
+using NitroxModel.DataStructures.Util;
+
+namespace NitroxServer.ConsoleCommands.Abstract
+{
+    public abstract partial class Command
+    {
+        public class CallArgs
+        {
+            public CallArgs(Command command, Optional<Player> sender, string[] args)
+            {
+                Command = command;
+                Sender = sender;
+                Args = args;
+            }
+
+            public Command Command { get; }
+            public string[] Args { get; }
+            public Optional<Player> Sender { get; }
+
+            public string SenderName => Sender.HasValue ? Sender.Value.Name : "SERVER";
+
+            public bool Valid(int index)
+            {
+                return index < Args.Length && index >= 0 && Args.Length != 0;
+            }
+
+            public string Get(int index)
+            {
+                return Get<string>(index);
+            }
+
+            public string GetTillEnd(int startIndex = 0)
+            {
+                // TODO: Proper argument capture/parse instead of this argument join hack
+                if (Args?.Length > 0)
+                {
+                    return string.Join(" ", Args.Skip(startIndex));
+                }
+
+                return string.Empty;
+            }
+
+            public T Get<T>(int index)
+            {
+                IParameter<object> param = Command.Parameters[index];
+                string arg = Valid(index) ? Args[index] : null;
+
+                if (arg == null)
+                {
+                    return default(T);
+                }
+                if (typeof(T) == typeof(string))
+                {
+                    return (T)(object)arg;
+                }
+
+                return (T)param.Read(arg);
+            }
+        }
+    }
+}

NitroxServer/ConsoleCommands/Abstract/Command.cs

@@ -1,62 +1,110 @@
-using NitroxModel.DataStructures.Util;
-using NitroxModel.Helper;
+using System;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using System.Linq;
+using System.Text;
 using NitroxModel.DataStructures.GameLogic;
-using NitroxModel.Packets;
+using NitroxModel.DataStructures.Util;
+using NitroxModel.Helper;
 using NitroxModel.Logger;
-using System.Text;
+using NitroxModel.Packets;
 
 namespace NitroxServer.ConsoleCommands.Abstract
 {
-    public abstract class Command
+    public abstract partial class Command
     {
-        public string Name { get; protected set; }
-        public string[] Alias { get; protected set; }
-        public string Description { get; protected set; }
-        public string ArgsDescription { get; protected set; }
-        public Perms RequiredPermLevel { get; protected set; }
+        private readonly List<string> aliases;
+        private int optional, required;
 
-        protected Command(string name, Perms requiredPermLevel, string argsDescription, string description) : this(name, requiredPermLevel, argsDescription, "", null)
-        {
-            ArgsDescription = argsDescription;
-            Name = name;
-            Description = description;
-        }
+        public ReadOnlyCollection<string> Aliases => aliases.AsReadOnly();
+
+        public string Name { get; }
+        public string Description { get; }
+        public Perms RequiredPermLevel { get; }
+        public bool AllowedArgOverflow { get; }
+        public List<IParameter<object>> Parameters { get; }
 
-        protected Command(string name, Perms requiredPermLevel, string argsDescription, string description, string[] alias)
+        protected Command(string name, Perms perm, string description, bool allowedArgOveflow = false)
         {
             Validate.NotNull(name);
-            Validate.NotNull(argsDescription);
-            Validate.NotNull(description);
 
             Name = name;
-            Description = string.IsNullOrEmpty(description) ? "No description" : description;
-            ArgsDescription = argsDescription;
-            RequiredPermLevel = requiredPermLevel;
-            Alias = alias ?? new string[0];
+            RequiredPermLevel = perm;
+            aliases = new List<string>();
+            Parameters = new List<IParameter<object>>();
+            AllowedArgOverflow = allowedArgOveflow;
+            Description = string.IsNullOrEmpty(description) ? "No description provided" : description;
         }
 
-        public abstract void RunCommand(string[] args, Optional<Player> sender);
+        protected abstract void Execute(CallArgs args);
 
-        public abstract bool VerifyArgs(string[] args);
-
-        public override string ToString()
+        public void TryExecute(Optional<Player> sender, string[] args)
         {
-            return $"{nameof(Name)}: {Name}, {nameof(Description)}: {Description}, {nameof(ArgsDescription)}: {ArgsDescription}, {nameof(Alias)}: [{string.Join(", ", Alias)}]";
+            if (args.Length < required)
+            {
+                SendMessage(sender, $"Error: Invalid Parameters\nUsage: {ToHelpText(true)}");
+                return;
+            }
+
+            if (!AllowedArgOverflow && args.Length > optional + required)
+            {
+                SendMessage(sender, $"Error: Too many Parameters\nUsage: {ToHelpText(true)}");
+                return;
+            }
+
+            try
+            {
+                Execute(new CallArgs(this, sender, args));
+            }
+            catch (ArgumentException e)
+            {
+                SendMessage(sender, $"Error: {e.Message}");
+            }
+            catch (Exception e)
+            {
+                Log.Error("Fatal error while trying to execute the command", e);
+            }
         }
 
-        public string ToHelpText()
+        public string ToHelpText(bool cropText = false)
         {
             StringBuilder cmd = new StringBuilder(Name);
+            if (Aliases?.Count > 0)
+            {
+                cmd.AppendFormat("/{0}", string.Join("/", Aliases));
+            }
+            cmd.AppendFormat(" {0}", string.Join(" ", Parameters));
+            return cropText ? $"{cmd}" : $"{cmd,-32} - {Description}";
+        }
+
+        protected void AddParameter<T>(T param) where T : IParameter<object>
+        {
+            Validate.NotNull(param as object);
 
-            if (Alias.Length > 0)
+            Parameters.Add(param);
+            if (param.IsRequired)
             {
-                cmd.AppendFormat("/{0}", string.Join("/", Alias));
+                required++;
             }
-            cmd.AppendFormat(" {0}", ArgsDescription);
+            else
+            {
+                optional++;
+            }
+        }
 
-            return $"{cmd,-35}  -  {Description}";
+        protected void AddAlias(params string[] alias)
+        {
+            aliases.AddRange(alias);
         }
 
+        protected void AddAlias(string alias)
+        {
+            aliases.Add(alias);
+        }
+
+        /// <summary>
+        ///     Send a message to an existing player
+        /// </summary>
         public void SendMessageToPlayer(Optional<Player> player, string message)
         {
             if (player.HasValue)
@@ -65,10 +113,13 @@ public void SendMessageToPlayer(Optional<Player> player, string message)
             }
         }
 
-        public void Notify(Optional<Player> player, string message)
+        /// <summary>
+        ///     Send a message to an existing player and logs it in the console
+        /// </summary>
+        public void SendMessage(Optional<Player> player, string message)
         {
-            Log.Info(message);
             SendMessageToPlayer(player, message);
+            Log.Info(message);
         }
     }
 }

NitroxServer/ConsoleCommands/Abstract/Parameter.cs

@@ -0,0 +1,35 @@
+using NitroxModel.Helper;
+
+namespace NitroxServer.ConsoleCommands.Abstract
+{
+    public abstract class Parameter<T> : IParameter<T>
+    {
+        public bool IsRequired { get; }
+        public string Name { get; }
+
+        protected Parameter(string name, bool isRequired)
+        {
+            Validate.IsFalse(string.IsNullOrEmpty(name));
+
+            Name = name;
+            IsRequired = isRequired;
+        }
+
+        public abstract bool IsValid(string arg);
+        public abstract T Read(string arg);
+
+        public override string ToString()
+        {
+            return $"{(IsRequired ? '{' : '[')}{Name}{(IsRequired ? '}' : ']')}";
+        }
+    }
+
+    public interface IParameter<out T>
+    {
+        bool IsRequired { get; }
+        string Name { get; }
+
+        bool IsValid(string arg);
+        T Read(string arg);
+    }
+}