add: implement MySQL database support (#141)

fltuna · web-flow · commit 253239edf16c · 2025-05-19T15:09:40.000+09:00
diff --git a/MapChooserSharp/Modules/McsDatabase/McsDatabaseProvider.cs b/MapChooserSharp/Modules/McsDatabase/McsDatabaseProvider.cs
@@ -1,4 +1,6 @@
-﻿using MapChooserSharp.Modules.McsDatabase.Interfaces;
+﻿using System.Runtime.InteropServices;
+using System.Security;
+using MapChooserSharp.Modules.McsDatabase.Interfaces;
 using MapChooserSharp.Modules.McsDatabase.Repositories;
 using MapChooserSharp.Modules.McsDatabase.Repositories.Interfaces;
 using MapChooserSharp.Modules.PluginConfig.Interfaces;
@@ -51,8 +53,26 @@ private void ConfigureDatabase()
         switch (config.GeneralConfig.SqlConfig.DataBaseType)
         {
             case McsSupportedSqlType.MySql:
-                // Plugin.Logger.LogInformation("Using MySQL database");
-                throw new NotImplementedException("MySQL support is not implemented yet");
+                _providerType = McsSupportedSqlType.MySql;    
+                string password = ConvertSecureStringToString(config.GeneralConfig.SqlConfig.Password);
+
+                try
+                {
+                    _connectionString = $"Server={config.GeneralConfig.SqlConfig.Host};" +
+                                        $"Database={config.GeneralConfig.SqlConfig.DatabaseName};" +
+                                        $"User Id={config.GeneralConfig.SqlConfig.UserName};" +
+                                        $"Password={password};" +
+                                        $"Port={config.GeneralConfig.SqlConfig.Port};";
+                    
+                    Plugin.Logger.LogInformation($"Using MySQL database at host: {config.GeneralConfig.SqlConfig.Host}, Database Name: {config.GeneralConfig.SqlConfig.DatabaseName}");
+                }
+                finally
+                {
+                    // Clear password from memory ASAP
+                    SecurelyEraseString(ref password);
+                }
+                
+                break;
                 
             case McsSupportedSqlType.PostgreSql:
                 // Plugin.Logger.LogInformation("Using PostgreSQL database");
@@ -61,10 +81,45 @@ private void ConfigureDatabase()
             case McsSupportedSqlType.Sqlite:
             default:
                 _providerType = McsSupportedSqlType.Sqlite;
-                string dbPath = Path.Combine(Plugin.ModuleDirectory, "MapChooserSharp.db");
+                string dbPath = Path.Combine(Plugin.ModuleDirectory, config.GeneralConfig.SqlConfig.DatabaseName);
                 _connectionString = $"Data Source={dbPath}";
                 Plugin.Logger.LogInformation($"Using SQLite database at {dbPath}");
                 break;
         }
     }
+    
+    private string ConvertSecureStringToString(SecureString secureString)
+    {
+        IntPtr bstrPtr = Marshal.SecureStringToBSTR(secureString);
+        try
+        {
+            return Marshal.PtrToStringBSTR(bstrPtr);
+        }
+        finally
+        {
+            Marshal.ZeroFreeBSTR(bstrPtr);
+        }
+    }
+    
+    private void SecurelyEraseString(ref string value)
+    {
+        if (string.IsNullOrEmpty(value))
+            return;
+        
+        GCHandle handle = GCHandle.Alloc(value, GCHandleType.Pinned);
+    
+        try
+        {
+            IntPtr ptr = handle.AddrOfPinnedObject();
+            int size = value.Length * sizeof(char);
+        
+            Marshal.Copy(new byte[size], 0, ptr, size);
+        }
+        finally
+        {
+            handle.Free();
+        
+            value = "";
+        }
+    }
 }
diff --git a/MapChooserSharp/Modules/McsDatabase/Repositories/SqlProviders/MySql/MySqlGroupSqlQueries.cs b/MapChooserSharp/Modules/McsDatabase/Repositories/SqlProviders/MySql/MySqlGroupSqlQueries.cs
@@ -6,13 +6,25 @@ internal sealed class MySqlGroupSqlQueries(string tableName) : IMcsGroupSqlQueri
 {
     public string TableName { get; } = tableName;
 
-    public string GetEnsureTableExistsSql() => throw new NotImplementedException("This functionality is not implemented.");
+    public string GetEnsureTableExistsSql() => @$"
+        CREATE TABLE IF NOT EXISTS {TableName} (
+            Id INT AUTO_INCREMENT PRIMARY KEY,
+            GroupName VARCHAR(255) NOT NULL UNIQUE,
+            CooldownRemains INT NOT NULL
+        )";
     
-    public string GetDecrementCooldownsSql() => throw new NotImplementedException("This functionality is not implemented.");
+    public string GetDecrementCooldownsSql() => 
+        $"UPDATE {TableName} SET CooldownRemains = CooldownRemains - 1 WHERE CooldownRemains > 0";
     
-    public string GetUpsertGroupCooldownSql() => throw new NotImplementedException("This functionality is not implemented.");
+    public string GetUpsertGroupCooldownSql() => @$"
+        INSERT INTO {TableName} (GroupName, CooldownRemains) 
+        VALUES (@GroupName, @CooldownValue)
+        ON DUPLICATE KEY UPDATE 
+        CooldownRemains = @CooldownValue";
     
-    public string GetAllGroupInfosSql() => throw new NotImplementedException("This functionality is not implemented.");
+    public string GetAllGroupInfosSql() => 
+        $"SELECT * FROM {TableName}";
     
-    public string GetInsertGroupInfoSql() => throw new NotImplementedException("This functionality is not implemented.");
+    public string GetInsertGroupInfoSql() => 
+        $"INSERT INTO {TableName} (GroupName, CooldownRemains) VALUES (@GroupName, @CooldownRemains)";
 }
diff --git a/MapChooserSharp/Modules/McsDatabase/Repositories/SqlProviders/MySql/MySqlMapInformationSqlQueries.cs b/MapChooserSharp/Modules/McsDatabase/Repositories/SqlProviders/MySql/MySqlMapInformationSqlQueries.cs
@@ -6,15 +6,28 @@ internal sealed class MySqlMapInformationSqlQueries(string tableName) : IMcsMapI
 {
     public string TableName { get; } = tableName;
 
-    public string GetEnsureTableExistsSql() => throw new NotImplementedException("This functionality is not implemented.");
+    public string GetEnsureTableExistsSql() => @$"
+        CREATE TABLE IF NOT EXISTS {TableName} (
+            Id INT AUTO_INCREMENT PRIMARY KEY,
+            MapName VARCHAR(255) NOT NULL UNIQUE,
+            CooldownRemains INT NOT NULL
+        )";
     
-    public string GetDecrementCooldownsSql() => throw new NotImplementedException("This functionality is not implemented.");
+    public string GetDecrementCooldownsSql() => 
+        $"UPDATE {TableName} SET CooldownRemains = CooldownRemains - 1 WHERE CooldownRemains > 0";
     
-    public string GetUpsertMapInfoSql() => throw new NotImplementedException("This functionality is not implemented.");
+    public string GetUpsertMapInfoSql() => @$"
+        INSERT INTO {TableName} (MapName, CooldownRemains) 
+        VALUES (@MapName, @CooldownRemains)
+        ON DUPLICATE KEY UPDATE 
+        CooldownRemains = @CooldownRemains";
     
-    public string GetAllMapInfosSql() => throw new NotImplementedException("This functionality is not implemented.");
+    public string GetAllMapInfosSql() => 
+        $"SELECT * FROM {TableName}";
     
-    public string GetMapInfoByNameSql() => throw new NotImplementedException("This functionality is not implemented.");
+    public string GetMapInfoByNameSql() => 
+        $"SELECT * FROM {TableName} WHERE MapName = @MapName";
 
-    public string GetInsertMapInfoSql() => throw new NotImplementedException("This functionality is not implemented.");
+    public string GetInsertMapInfoSql() =>
+        $"INSERT INTO {TableName} (MapName, CooldownRemains) VALUES (@MapName, @CooldownRemains)";
 }
diff --git a/MapChooserSharp/Modules/PluginConfig/Interfaces/IMcsSqlConfig.cs b/MapChooserSharp/Modules/PluginConfig/Interfaces/IMcsSqlConfig.cs
@@ -7,9 +7,13 @@ public interface IMcsSqlConfig
 {
     internal McsSupportedSqlType DataBaseType { get; }
     
-    internal string Address { get; }
+    internal string Host { get; }
     
-    internal string User { get; }
+    internal string Port { get; }
+    
+    internal string DatabaseName { get; }
+    
+    internal string UserName { get; }
     
     internal SecureString Password { get; }
     
diff --git a/MapChooserSharp/Modules/PluginConfig/McsPluginConfigParser.cs b/MapChooserSharp/Modules/PluginConfig/McsPluginConfigParser.cs
@@ -344,11 +344,21 @@ private McsSqlConfig ParseSqlConfig(TomlTable tomlModel)
             throw new InvalidOperationException("General.Sql.Type is not found or invalid");
         }
         
-        if (!sqlTable.TryGetValue("Address", out var sqlAddressObj) || sqlAddressObj is not string sqlAddress)
+        if (!sqlTable.TryGetValue("Address", out var sqlAddressObj) || sqlAddressObj is not string sqlHost)
         {
             throw new InvalidOperationException("General.Sql.Address is not found or invalid");
         }
         
+        if (!sqlTable.TryGetValue("Port", out var sqlPortObj) || sqlPortObj is not string sqlPort)
+        {
+            throw new InvalidOperationException("General.Sql.Port is not found or invalid");
+        }
+        
+        if (!sqlTable.TryGetValue("DatabaseName", out var sqlDbNameObj) || sqlDbNameObj is not string sqlDbName)
+        {
+            throw new InvalidOperationException("General.Sql.DatabaseName is not found or invalid");
+        }
+        
         if (!sqlTable.TryGetValue("User", out var sqlUserObj) || sqlUserObj is not string sqlUser)
         {
             throw new InvalidOperationException("General.Sql.User is not found or invalid");
@@ -377,7 +387,7 @@ private McsSqlConfig ParseSqlConfig(TomlTable tomlModel)
             throw new InvalidOperationException("General.Sql.Type is invalid");
         }
 
-        var sqlConfig = new McsSqlConfig(sqlAddress, sqlUser, ref sqlPassword, groupTableName, mapTableName, type);
+        var sqlConfig = new McsSqlConfig(sqlHost, sqlPort, sqlDbName, sqlUser, ref sqlPassword, groupTableName, mapTableName, type);
         
         return sqlConfig;
     }
@@ -461,10 +471,13 @@ private void WriteDefaultConfig()
 #
 # Currently Supports:
 # - Sqlite
+# - MySQL
 #
 # See GitHub readme for more and updated information.
 Type = ""sqlite""
+DatabaseName = ""MapChooserSharp.db""
 Address = """"
+Port = """"
 User = """"
 Password = """"
 
diff --git a/MapChooserSharp/Modules/PluginConfig/Models/McsSqlConfig.cs b/MapChooserSharp/Modules/PluginConfig/Models/McsSqlConfig.cs
@@ -7,13 +7,15 @@ namespace MapChooserSharp.Modules.PluginConfig.Models;
 
 public sealed class McsSqlConfig: IMcsSqlConfig
 {
-    public McsSqlConfig(string address, string user, ref string password, string groupSettingsSqlTableName, string mapSettingsSqlTableName, McsSupportedSqlType dataBaseType)
+    public McsSqlConfig(string host, string port, string databaseName, string user, ref string password, string groupSettingsSqlTableName, string mapSettingsSqlTableName, McsSupportedSqlType dataBaseType)
     {
-        Address = address;
-        User = user;
+        Host = host;
+        UserName = user;
         GroupSettingsSqlTableName = groupSettingsSqlTableName;
         MapSettingsSqlTableName = mapSettingsSqlTableName;
         DataBaseType = dataBaseType;
+        Port = port;
+        DatabaseName = databaseName;
 
 
         Password = ConvertToSecureString(password);
@@ -23,8 +25,10 @@ public McsSqlConfig(string address, string user, ref string password, string gro
     }
 
     public McsSupportedSqlType DataBaseType { get; }
-    public string Address { get; }
-    public string User { get; }
+    public string Host { get; }
+    public string Port { get; }
+    public string DatabaseName { get; }
+    public string UserName { get; }
     public SecureString Password { get; }
     public string GroupSettingsSqlTableName { get; }
     public string MapSettingsSqlTableName { get; }
diff --git a/docs/en/configuration/PLUGIN_CONFIG.md b/docs/en/configuration/PLUGIN_CONFIG.md
@@ -36,10 +36,13 @@ Whether to display the number of seconds when RTV commands and other commands ar
 #
 # Currently Supports:
 # - Sqlite
+# - MySQL
 #
 # See GitHub readme for more and updated information.
 Type = "sqlite"
+DatabaseName = "MapChooserSharp.db"
 Address = ""
+Port = ""
 User = ""
 Password = ""
 
@@ -49,9 +52,13 @@ MapInformationTableName = "McsMapInformation"
 
 ### Type
 
-Specify the database type here. Currently only SQLite is supported.
+Specify the database type here.
 
-### Address, User, Password
+### DatabaseName
+
+Name of database, if database type is SQLite then this name will be a file name.
+
+### Address, Port, User, Password
 
 These will be necessary for connecting to the database when MySQL and PostgreSQL are supported in the future.
 
diff --git a/docs/ja/configuration/PLUGIN_CONFIG.md b/docs/ja/configuration/PLUGIN_CONFIG.md
@@ -37,10 +37,13 @@ RTVコマンドなどがクールダウンのときに秒数を表示するか
 #
 # Currently Supports:
 # - Sqlite
+# - MySQL
 #
 # See GitHub readme for more and updated information.
 Type = "sqlite"
+DatabaseName = "MapChooserSharp.db"
 Address = ""
+Port = ""
 User = ""
 Password = ""
 
@@ -50,9 +53,13 @@ MapInformationTableName = "McsMapInformation"
 
 ### Type
 
-データベースタイプをここで指定します。 現在はSqliteのみサポートしています。
+データベースタイプをここで指定します。
 
-### Address, User, Password
+### DatabaseName
+
+データベース名を指定します。 SQLiteを使用している際は、ここの名前がファイル名になります。
+
+### Address, Port, User, Password
 
 これは将来的にMySQLやPostgreSQLをサポートした際に、データベースに接続するために必要になります。
 

Original file line number	Diff line number	Diff line change
`@@ -344,11 +344,21 @@ private McsSqlConfig ParseSqlConfig(TomlTable tomlModel)`
`344`	`344`	`throw new InvalidOperationException("General.Sql.Type is not found or invalid");`
`345`	`345`	`}`
`346`	`346`
`347`		`- if (!sqlTable.TryGetValue("Address", out var sqlAddressObj) \|\| sqlAddressObj is not string sqlAddress)`
	`347`	`+ if (!sqlTable.TryGetValue("Address", out var sqlAddressObj) \|\| sqlAddressObj is not string sqlHost)`
`348`	`348`	`{`
`349`	`349`	`throw new InvalidOperationException("General.Sql.Address is not found or invalid");`
`350`	`350`	`}`
`351`	`351`
	`352`	`+ if (!sqlTable.TryGetValue("Port", out var sqlPortObj) \|\| sqlPortObj is not string sqlPort)`
	`353`	`+ {`
	`354`	`+ throw new InvalidOperationException("General.Sql.Port is not found or invalid");`
	`355`	`+ }`
	`356`	`+`
	`357`	`+ if (!sqlTable.TryGetValue("DatabaseName", out var sqlDbNameObj) \|\| sqlDbNameObj is not string sqlDbName)`
	`358`	`+ {`
	`359`	`+ throw new InvalidOperationException("General.Sql.DatabaseName is not found or invalid");`
	`360`	`+ }`
	`361`	`+`
`352`	`362`	`if (!sqlTable.TryGetValue("User", out var sqlUserObj) \|\| sqlUserObj is not string sqlUser)`
`353`	`363`	`{`
`354`	`364`	`throw new InvalidOperationException("General.Sql.User is not found or invalid");`
`@@ -377,7 +387,7 @@ private McsSqlConfig ParseSqlConfig(TomlTable tomlModel)`
`377`	`387`	`throw new InvalidOperationException("General.Sql.Type is invalid");`
`378`	`388`	`}`
`379`	`389`
`380`		`- var sqlConfig = new McsSqlConfig(sqlAddress, sqlUser, ref sqlPassword, groupTableName, mapTableName, type);`
	`390`	`+ var sqlConfig = new McsSqlConfig(sqlHost, sqlPort, sqlDbName, sqlUser, ref sqlPassword, groupTableName, mapTableName, type);`
`381`	`391`
`382`	`392`	`return sqlConfig;`
`383`	`393`	`}`
`@@ -461,10 +471,13 @@ private void WriteDefaultConfig()`
`461`	`471`	`#`
`462`	`472`	`# Currently Supports:`
`463`	`473`	`# - Sqlite`
	`474`	`+# - MySQL`
`464`	`475`	`#`
`465`	`476`	`# See GitHub readme for more and updated information.`
`466`	`477`	`Type = ""sqlite""`
	`478`	`+DatabaseName = ""MapChooserSharp.db""`
`467`	`479`	`Address = """"`
	`480`	`+Port = """"`
`468`	`481`	`User = """"`
`469`	`482`	`Password = """"`
`470`	`483`