Merge pull request #2103 from sbwalker/dev

refactored IUpgradeable to use the migration attribute approach

Oqtane.Server/Infrastructure/DatabaseManager.cs

@@ -673,43 +673,61 @@ namespace Oqtane.Infrastructure
         {
             var result = new Installation { Success = false, Message = string.Empty };
 
+            // get site upgrades
+            Dictionary<string, Type> siteupgrades = new Dictionary<string, Type>();
+            var assemblies = AppDomain.CurrentDomain.GetOqtaneAssemblies();
+            foreach (Assembly assembly in assemblies)
+            {
+                foreach (var type in assembly.GetTypes(typeof(ISiteUpgrade)))
+                {
+                    if (Attribute.IsDefined(type, typeof(SiteUpgradeAttribute)))
+                    {
+                        var attribute = (SiteUpgradeAttribute)Attribute.GetCustomAttribute(type, typeof(SiteUpgradeAttribute));
+                        siteupgrades.Add(attribute.AliasName + " " + attribute.Version, type);
+                    }
+                }
+            }
+
+            // execute site upgrades
+            if (siteupgrades.Count > 0)
+            {
                 using (var scope = _serviceScopeFactory.CreateScope())
                 {
                     var aliases = scope.ServiceProvider.GetRequiredService<IAliasRepository>();
                     var tenantManager = scope.ServiceProvider.GetRequiredService<ITenantManager>();
                     var sites = scope.ServiceProvider.GetRequiredService<ISiteRepository>();
+                    var logger = scope.ServiceProvider.GetRequiredService<ILogManager>();
 
-                var assemblies = AppDomain.CurrentDomain.GetOqtaneAssemblies();
-                foreach (Assembly assembly in assemblies)
-                {
-                    foreach (var type in assembly.GetTypes().Where(item => item.GetInterfaces().Contains(typeof(IUpgradeable))))
-                    {
-                        var obj = Activator.CreateInstance(type) as IUpgradeable;
-                        if (obj != null)
-                        {
                     foreach (var alias in aliases.GetAliases().ToList().Where(item => item.IsDefault))
                     {
-                                var versions = obj.GetVersions(alias);
+                        foreach (var upgrade in siteupgrades)
-                                if (!string.IsNullOrEmpty(versions))
+                        {
+                            if (upgrade.Key.StartsWith(alias.Name, StringComparison.OrdinalIgnoreCase))
                             {
                                 tenantManager.SetTenant(alias.TenantId);
                                 var site = sites.GetSites().FirstOrDefault(item => item.SiteId == alias.SiteId);
                                 if (site != null)
                                 {
-                                        foreach (var version in versions.Split(',', StringSplitOptions.RemoveEmptyEntries))
+                                    var version = upgrade.Key.Split(' ').Last();
-                                        {
                                     if (string.IsNullOrEmpty(site.Version) || Version.Parse(version) > Version.Parse(site.Version))
                                     {
-                                                if (obj.Upgrade(alias, version))
+                                        try
+                                        {
+                                            var obj = Activator.CreateInstance(upgrade.Value) as ISiteUpgrade;
+                                            if (obj.Upgrade(site, alias))
                                             {
                                                 site.Version = version;
                                                 sites.UpdateSite(site);
+                                                logger.Log(alias.SiteId, Shared.LogLevel.Information, "Site Upgrade", LogFunction.Other, "Site Upgraded Successfully To Version {version} For {Alias}", version, alias.Name);
                                             }
                                             else
                                             {
-                                                    result.Message = "An Error Occurred Executing IUpgradeable Interface For " + alias.Name + " For Version " + version;
+                                                logger.Log(alias.SiteId, Shared.LogLevel.Error, "Site Upgrade", LogFunction.Other, "Site Could Not Be Upgraded Using IUpgradeable Interface {Type} For {Alias} And Version {Version}", upgrade.Value, alias.Name, version);
                                             }
                                         }
+                                        catch (Exception ex)
+                                        {
+                                            logger.Log(alias.SiteId, Shared.LogLevel.Error, "Site Upgrade", LogFunction.Other, "An Error Occurred Executing IUpgradeable Interface {Type} For {Alias} And Version {Version} {Error}", upgrade.Value, alias.Name, version, ex.Message);
                                         }
                                     }
                                 }
@@ -719,15 +737,7 @@ namespace Oqtane.Infrastructure
                 }
             }
 
-            if (string.IsNullOrEmpty(result.Message))
-            {
             result.Success = true;
-            }
-            else
-            {
-                _filelogger.LogError(Utilities.LogMessage(this, result.Message));
-            }
-
             return result;
         }
 

Oqtane.Server/Infrastructure/Interfaces/ISiteUpgrade.cs

@@ -0,0 +1,9 @@
+using Oqtane.Models;
+
+namespace Oqtane.Infrastructure
+{
+    public interface ISiteUpgrade
+    {
+        bool Upgrade(Site site, Alias alias);
+    }
+}

Oqtane.Server/Infrastructure/Interfaces/IUpgradeable.cs

@@ -1,11 +0,0 @@
-using Oqtane.Models;
-
-namespace Oqtane.Infrastructure
-{
-    public interface IUpgradeable
-    {
-        string GetVersions(Alias alias);
-
-        bool Upgrade(Alias alias, string version);
-    }
-}

Oqtane.Server/Infrastructure/Interfaces/SiteUpgradeAttribute.cs

@@ -0,0 +1,27 @@
+using System;
+
+namespace Oqtane.Infrastructure
+{
+    [AttributeUsage(AttributeTargets.Class)]
+    public class SiteUpgradeAttribute : Attribute
+    {
+        private string aliasname;
+        private string version;
+
+        public SiteUpgradeAttribute(string AliasName, string Version)
+        {
+            aliasname = AliasName;
+            version = Version;
+        }
+
+        public virtual string AliasName
+        {
+            get { return aliasname; }
+        }
+
+        public virtual string Version
+        {
+            get { return version; }
+        }
+    }
+}

Oqtane.Server/Infrastructure/SiteUpgrade/ExampleUpgrade.cs

@@ -1,41 +1,14 @@
 using Oqtane.Models;
-using Oqtane.Documentation;
 
 namespace Oqtane.Infrastructure
 {
-    [PrivateApi("Mark Site-Template classes as private, since it's not very useful in the public docs")]
+    [SiteUpgrade("localhost:44357", "01.00.00")]
-    public class ExampleUpgrade : IUpgradeable
+    public class ExampleUpgrade : ISiteUpgrade
     {
-        string IUpgradeable.GetVersions(Alias alias)
+        bool ISiteUpgrade.Upgrade(Site site, Alias alias)
         {
-            var versions = "";
-            switch (alias.Name)
-            {
-                case "localhost:44357":
-                    // return the comma delimited list of official release versions for the specific site
-                    versions = "1.0.0";
-                    break;
-            }
-            return versions;
-        }
-
-        bool IUpgradeable.Upgrade(Alias alias, string version)
-        {
-            bool success = true;
-            switch (alias.Name)
-            {
-                case "localhost:44357":
-                    // the version cases should match the list of versions returned above
-                    switch (version)
-                    {
-                        case "1.0.0":
             // execute some version-specific upgrade logic for the site here such as adding pages, modules, content, etc...
-                            success = true;
+            return true;
-                            break;
-                    }
-                    break;
-            }
-            return success;
         }
     }
 }