inabox/InABox.Database/DataUpdater.cs

using InABox.Configuration;
using InABox.Core;
using Microsoft.CodeAnalysis.Scripting;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using NPOI.XWPF.Usermodel;

namespace InABox.Database;

public static class DataUpdater
{
    private static Dictionary<VersionNumber, List<DatabaseUpdateScript>> updateScripts = new();

    /// <summary>
    /// Register a migration script to run when updating to this version.
    /// 
    /// <para>The <paramref name="action"/> should probably be repeatable; 
    /// that is, if you run it a second time, it only updates data that needed updating. This way if it accidentally somehow gets run twice, there is no issue.
    /// </para>
    /// </summary>
    /// <param name="version">The version to update to.</param>
    /// <param name="action">The action to be run.</param>
    public static void RegisterUpdateScript<TUpdater>()
        where TUpdater : DatabaseUpdateScript, new()
    {
        var updater = new TUpdater();
        
        if(!updateScripts.TryGetValue(updater.Version, out var list))
        {
            list = new();
            updateScripts[updater.Version] = list;
        }
        list.Add(updater);
    }

    private static bool MigrateDatabase(VersionNumber fromVersion, VersionNumber toVersion, out VersionNumber newVersion)
    {
        var versionNumbers = updateScripts.Keys.ToList();
        versionNumbers.Sort();
        
        newVersion = fromVersion;

        int? index = null;
        foreach (var (i, number) in versionNumbers.Select((x, i) => new Tuple<int, VersionNumber>(i, x)))
        {
            if (number > fromVersion)
            {
                index = i;
                break;
            }
        }
        if(index != null && fromVersion < toVersion)
        {
            Logger.Send(LogType.Information, "", $"Updating database from {fromVersion} to {toVersion}");
            for (int i = (int)index; i < versionNumbers.Count; i++)
            {
                var version = versionNumbers[i];
                if (toVersion < version)
                {
                    break;
                }
                Logger.Send(LogType.Information, "", $"Executing update to {version}");
                foreach(var updater in updateScripts[version])
                {
                    if (!updater.Update())
                    {
                        Logger.Send(LogType.Error, "", $"Script failed, cancelling migration");
                        return false;
                    }
                }
                newVersion = version;
            }
            Logger.Send(LogType.Information, "", $"Data migration complete!");
        }
        newVersion = toVersion;
        return true;
    }
    
    private static void UpdateVersionNumber(VersionNumber version)
    {
        if (version.IsDevelopmentVersion)
            return;
        var dbVersion = DbFactory.GetVersionSettings();
        dbVersion.Version = version.ToString();

        var result = DbFactory.NewProvider(Logger.Main).Query(Filter<GlobalSettings>.Where(x => x.Section).IsEqualTo(nameof(DatabaseVersion)))
            .Rows.FirstOrDefault()?.ToObject<GlobalSettings>() ?? new GlobalSettings() { Section = nameof(DatabaseVersion), Key = "" };
        result.OriginalValueList["Contents"] = result.Contents;
        result.Contents = Serialization.Serialize(dbVersion);
        DbFactory.NewProvider(Logger.Main).Save(result);
    }

    /// <summary>
    /// Migrates the database to the current version.
    /// </summary>
    /// <returns><c>false</c> if the migration fails.</returns>
    public static bool MigrateDatabase()
    {
        try
        {
            var from = DbFactory.GetDatabaseVersion();
            var to = VersionNumber.Parse(CoreUtils.GetVersion());

            var success = MigrateDatabase(from, to, out var newVersion);
            if (newVersion != from)
            {
                UpdateVersionNumber(newVersion);
            }
            return success;
        }
        catch(Exception e)
        {
            Logger.Send(LogType.Error, "", $"Error while migrating database: {CoreUtils.FormatException(e)}");
            return false;
        }
    }
    
    public static bool DoSpecificMigration(VersionNumber from, VersionNumber to)
    {
        try
        {
            var _success = MigrateDatabase(from, to, out var _);
            return _success;
        }
        catch(Exception e)
        {
            Logger.Send(LogType.Error, "", $"Error while migrating database: {CoreUtils.FormatException(e)}");
            return false;
        }
    }
}