feat: Provide configuration standard for plugins (#67)

configs/addons/counterstrikesharp/configs/plugins/README.txt

@@ -0,0 +1,4 @@
+Place your plugin configurations here.
+
+TestPlugin/TestPlugin.json
+AnotherPlugin/AnotherPlugin.json

managed/CounterStrikeSharp.API/Core/BasePlugin.cs

@@ -30,6 +30,8 @@ using CounterStrikeSharp.API.Modules.Events;
 using CounterStrikeSharp.API.Modules.Entities;
 using CounterStrikeSharp.API.Modules.Listeners;
 using CounterStrikeSharp.API.Modules.Timers;
+using McMaster.NETCore.Plugins;
+using CounterStrikeSharp.API.Modules.Config;
 
 namespace CounterStrikeSharp.API.Core
 {
@@ -333,6 +335,31 @@ namespace CounterStrikeSharp.API.Core
             this.RegisterConsoleCommandAttributeHandlers(instance);
         }
 
+        public void InitializeConfig(object instance, Type pluginType)
+        {
+            Type[] interfaces = pluginType.GetInterfaces();
+            Func<Type, bool> predicate = (i => i.IsGenericType && i.GetGenericTypeDefinition() == typeof(IPluginConfig<>));
+
+            // if the plugin has set a configuration type (implements IPluginConfig<>)
+            if (interfaces.Any(predicate))
+            {
+                // IPluginConfig<>
+                Type @interface = interfaces.Where(predicate).FirstOrDefault()!;
+
+                // custom config type passed as generic
+                Type genericType = @interface!.GetGenericArguments().First();
+
+                var config = typeof(ConfigManager)
+                    .GetMethod("Load")!
+                    .MakeGenericMethod(genericType)
+                    .Invoke(null, new object[] { Path.GetFileName(ModuleDirectory) }) as IBasePluginConfig;
+
+                // we KNOW that we can do this "safely"
+                pluginType.GetRuntimeMethod("OnConfigParsed", new Type[] { genericType })
+                    .Invoke(instance, new object[] { config });
+            }
+        }
+
         /// <summary>
         /// Registers all game event handlers that are decorated with the `[GameEventHandler]` attribute.
         /// </summary>

managed/CounterStrikeSharp.API/Core/BasePluginConfig.cs

@@ -0,0 +1,32 @@
+/*
+ *  This file is part of CounterStrikeSharp.
+ *  CounterStrikeSharp is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  CounterStrikeSharp is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with CounterStrikeSharp.  If not, see <https://www.gnu.org/licenses/>. *
+ */
+
+using System.Text.Json.Serialization;
+
+namespace CounterStrikeSharp.API.Core
+{
+    public interface IBasePluginConfig
+    {
+        [JsonPropertyName("ConfigVersion")]
+        int Version { get; set; }
+    }
+
+    public class BasePluginConfig : IBasePluginConfig
+    {
+        [JsonPropertyName("ConfigVersion")]
+        public virtual int Version { get; set; } = 1;
+    }
+}

managed/CounterStrikeSharp.API/Core/CoreConfig.cs

@@ -62,7 +62,9 @@ namespace CounterStrikeSharp.API.Core
         ///
         /// <para>
         /// Enabling this option will block plugins from using functionality that is known to cause this.
+        ///
         /// Note that this does NOT guarantee that you cannot
+        ///
         /// receive a ban.
         /// </para>
         ///

managed/CounterStrikeSharp.API/Core/IPluginConfig.cs

@@ -0,0 +1,28 @@
+/*
+ *  This file is part of CounterStrikeSharp.
+ *  CounterStrikeSharp is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  CounterStrikeSharp is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with CounterStrikeSharp.  If not, see <https://www.gnu.org/licenses/>. *
+ */
+
+namespace CounterStrikeSharp.API.Core
+{
+    /// <summary>
+    /// An interface that describes a plugin configuration.
+    /// </summary>
+    public interface IPluginConfig<T> where T: IBasePluginConfig, new()
+    {
+        T Config { get; set; }
+
+        public void OnConfigParsed(T config);
+    }
+}

managed/CounterStrikeSharp.API/Core/PluginContext.cs

@@ -20,6 +20,7 @@ using System.Linq;
 using System.Reflection;
 using System.Threading.Tasks;
 using CounterStrikeSharp.API.Core.Attributes;
+using CounterStrikeSharp.API.Modules.Config;
 using CounterStrikeSharp.API.Modules.Events;
 using McMaster.NETCore.Plugins;
 
@@ -103,6 +104,7 @@ namespace CounterStrikeSharp.API.Core
                 _plugin = (BasePlugin)Activator.CreateInstance(pluginType)!;
                 _plugin.ModulePath = _path;
                 _plugin.RegisterAllAttributes(_plugin);
+                _plugin.InitializeConfig(_plugin, pluginType);
                 _plugin.Load(hotReload);
 
                 Console.WriteLine($"Finished loading plugin: {Name}");

managed/CounterStrikeSharp.API/Modules/Config/ConfigManager.cs

@@ -0,0 +1,79 @@
+/*
+ *  This file is part of CounterStrikeSharp.
+ *  CounterStrikeSharp is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  CounterStrikeSharp is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with CounterStrikeSharp.  If not, see <https://www.gnu.org/licenses/>. *
+ */
+
+using System;
+using System.IO;
+using System.Reflection;
+using System.Text;
+using System.Text.Json;
+
+using CounterStrikeSharp.API.Core;
+
+namespace CounterStrikeSharp.API.Modules.Config
+{
+    public static class ConfigManager
+    {
+        private static readonly DirectoryInfo? _rootDir;
+
+        private static readonly string _pluginConfigsFolderPath;
+
+        static ConfigManager()
+        {
+            _rootDir = new FileInfo(Assembly.GetExecutingAssembly().Location).Directory.Parent;
+            _pluginConfigsFolderPath = Path.Combine(_rootDir.FullName, "configs", "plugins");
+        }
+
+        public static T Load<T>(string pluginName) where T : IBasePluginConfig, new()
+        {
+            string directoryPath = Path.Combine(_pluginConfigsFolderPath, pluginName);
+            string configPath = Path.Combine(directoryPath, $"{pluginName}.json");
+
+            T config = (T)Activator.CreateInstance(typeof(T))!;
+
+            if (!File.Exists(configPath))
+            {
+                try
+                {
+                    if (!Directory.Exists(directoryPath))
+                    {
+                        Directory.CreateDirectory(directoryPath);
+                    }
+
+                    StringBuilder builder = new StringBuilder();
+                    builder.Append($"// This configuration was automatically generated by CounterStrikeSharp for plugin '{pluginName}', at {DateTimeOffset.Now:yyyy/MM/dd hh:mm:ss}\n");
+                    builder.Append(JsonSerializer.Serialize<T>(config, new JsonSerializerOptions { WriteIndented = true }));
+                    File.WriteAllText(configPath, builder.ToString());
+                    return config;
+                }
+                catch (Exception ex)
+                {
+                    Console.WriteLine($"Failed to generate configuration file for {pluginName}: {ex}");
+                }
+            }
+
+            try
+            {
+                config = JsonSerializer.Deserialize<T>(File.ReadAllText(configPath), new JsonSerializerOptions() { ReadCommentHandling = JsonCommentHandling.Skip })!;
+            }
+            catch (Exception ex)
+            {
+                Console.WriteLine($"Failed to parse configuration '{pluginName}': {ex}");
+            }
+
+            return config;
+        }
+    }
+}

managed/TestPlugin/TestPlugin.cs

@@ -18,6 +18,8 @@ using System;
 using System.Drawing;
 using System.IO;
 using System.Linq;
+using System.Text.Json.Serialization;
+
 using CounterStrikeSharp.API;
 using CounterStrikeSharp.API.Core;
 using CounterStrikeSharp.API.Core.Attributes;
@@ -32,8 +34,17 @@ using CounterStrikeSharp.API.Modules.Utils;
 
 namespace TestPlugin
 {
-    [MinimumApiVersion(1)]
-    public class SamplePlugin : BasePlugin
+    public class SampleConfig : BasePluginConfig
+    {
+        [JsonPropertyName("IsPluginEnabled")]
+        public bool IsPluginEnabled { get; set; } = true;
+
+        [JsonPropertyName("LogPrefix")]
+        public string LogPrefix { get; set; } = "CSSharp";
+    }
+
+    [MinimumApiVersion(33)]
+    public class SamplePlugin : BasePlugin, IPluginConfig<SampleConfig>
     {
         public override string ModuleName => "Sample Plugin";
         public override string ModuleVersion => "v1.0.0";
@@ -42,8 +53,24 @@ namespace TestPlugin
 
         public override string ModuleDescription => "A playground of features used for testing";
 
+        public SampleConfig Config { get; set; }
+
+        // This method is called right before `Load` is called
+        public void OnConfigParsed(SampleConfig config)
+        {
+            // Save config instance
+            Config = config;
+        }
+
         public override void Load(bool hotReload)
         {
+            // Basic usage of the configuration system
+            if (!Config.IsPluginEnabled)
+            {
+                Console.WriteLine($"{Config.LogPrefix} {ModuleName} is disabled");
+                return;
+            }
+
             Console.WriteLine(
                 $"Test Plugin has been loaded, and the hot reload flag was {hotReload}, path is {ModulePath}");