TShock/TShockAPI/DB/DbBuilder.cs

using System;
using System.Data;
using System.Diagnostics;
using System.IO;
using Microsoft.Data.Sqlite;
using MySql.Data.MySqlClient;
using Npgsql;
using TerrariaApi.Server;
using TShockAPI.Configuration;

namespace TShockAPI.DB;

/// <summary>
/// Provides logic to build a DB connection.
/// </summary>
public sealed class DbBuilder
{
	private readonly TShock _caller;
	private readonly TShockConfig _config;
	private readonly string _savePath;

	/// <summary>
	/// Initializes a new instance of the <see cref="DbBuilder"/> class.
	/// </summary>
	/// <param name="caller">The TShock instance calling this DbBuilder.</param>
	/// <param name="config">The TShock configuration, supplied by <see cref="TShock.Config" /> at init.</param>
	/// <param name="savePath">The savePath registered by TShock. See <see cref="TShock.SavePath" />.</param>
	public DbBuilder(TShock caller, TShockConfig config, string savePath)
	{
		_caller = caller;
		_config = config;
		_savePath = savePath;
	}

	/// <summary>
	/// Builds a DB connection based on the provided configuration.
	/// </summary>
	/// <param name="config">The TShock configuration.</param>
	/// <remarks>
	/// Default settings will result in a local sqlite database file named "tshock.db" in the current directory to be used as server DB.
	/// </remarks>
	public IDbConnection BuildDbConnection()
	{
		string dbType = _config.Settings.StorageType.ToLowerInvariant();

		return dbType switch
		{
			"sqlite" => BuildSqliteConnection(),
			"mysql" => BuildMySqlConnection(),
			"postgres" => BuildPostgresConnection(),
			_ => throw new("Invalid storage type")
		};
	}

	private SqliteConnection BuildSqliteConnection()
	{
		try
		{
			// Handle first the connection string, if specified.
			if (_config.Settings.SqliteConnectionString is not (null or ""))
			{
				// Use factory to build the string, the path may be relative.
				SqliteConnectionStringBuilder builder = new(_config.Settings.SqliteConnectionString);
				builder.DataSource = GetDbFile(builder.DataSource).FullName;
				return new(builder.ConnectionString);
			}

			// Fallback to SqliteDBPath setting.
			string dbFilePath = GetDbFile(_config.Settings.SqliteDBPath).FullName;
			return new($"Data Source={dbFilePath};");
		}
		catch (SqliteException e)
		{
			ServerApi.LogWriter.PluginWriteLine(_caller, e.ToString(), TraceLevel.Error);
			throw new("Sqlite not setup correctly", e);
		}
	}

	private MySqlConnection BuildMySqlConnection()
	{
		try
		{
			// If specified, use the connection string instead of other parameters.
			if (_config.Settings.MySqlConnectionString is not (null or ""))
			{
				MySqlConnectionStringBuilder builder = new(_config.Settings.MySqlConnectionString);
				return new(builder.ToString());
			}

			string[] hostport = _config.Settings.MySqlHost.Split(':');

			MySqlConnectionStringBuilder connStrBuilder = new()
			{
				Server = hostport[0],
				Port = hostport.Length > 1 ? uint.Parse(hostport[1]) : 3306,
				Database = _config.Settings.MySqlDbName,
				UserID = _config.Settings.MySqlUsername,
				Password = _config.Settings.MySqlPassword
			};

			return new(connStrBuilder.ToString());
		}
		catch (MySqlException e)
		{
			ServerApi.LogWriter.PluginWriteLine(_caller, e.ToString(), TraceLevel.Error);
			throw new("MySql not setup correctly", e);
		}
	}

	private NpgsqlConnection BuildPostgresConnection()
	{
		try
		{
			// If specified, use the connection string instead of other parameters.
			if (_config.Settings.PostgresConnectionString is not (null or ""))
			{
				NpgsqlConnectionStringBuilder builder = new(_config.Settings.PostgresConnectionString);
				return new(builder.ToString());
			}

			string[] hostport = _config.Settings.PostgresHost.Split(':');

			NpgsqlConnectionStringBuilder connStrBuilder = new()
			{
				Host = hostport[0],
				Port = hostport.Length > 1 ? int.Parse(hostport[1]) : 5432,
				Database = _config.Settings.PostgresDbName,
				Username = _config.Settings.PostgresUsername,
				Password = _config.Settings.PostgresPassword
			};

			return new(connStrBuilder.ToString());
		}
		catch (NpgsqlException e)
		{
			ServerApi.LogWriter.PluginWriteLine(_caller, e.ToString(), TraceLevel.Error);
			throw new("Postgres not setup correctly", e);
		}
	}

	private FileInfo GetDbFile(string path)
	{
		FileInfo dbFile = new(Path.IsPathRooted(path) ? path : Path.Combine(_savePath, path));

		if (dbFile.Directory is not { } dbDir)
		{
			throw new DirectoryNotFoundException($"The SQLite database path '{path}' could not be found.");
		}

		if (!dbDir.Exists)
		{
			dbDir.Create();
		}

		return dbFile;
	}
}