Diplomarbeit-Absolventenverein/oqtane.framework-not-mirrored
Archived
9
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #2103 from sbwalker/dev

Browse Source 
refactored IUpgradeable to use the migration attribute approach
This commit is contained in:
Shaun Walker 2022-04-02 09:19:50 -04:00 committed by GitHub
commit 6f33e5e8a0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 87 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

82
Oqtane.Server/Infrastructure/DatabaseManager.cs
View File

@ -673,43 +673,61 @@ namespace Oqtane.Infrastructure
{
var result = new Installation { Success = false, Message = string.Empty };
using (var scope = _serviceScopeFactory.CreateScope())
// get site upgrades
Dictionary<string, Type> siteupgrades = new Dictionary<string, Type>();
var assemblies = AppDomain.CurrentDomain.GetOqtaneAssemblies();
foreach (Assembly assembly in assemblies)
{
var aliases = scope.ServiceProvider.GetRequiredService<IAliasRepository>();
var tenantManager = scope.ServiceProvider.GetRequiredService<ITenantManager>();
var sites = scope.ServiceProvider.GetRequiredService<ISiteRepository>();
var assemblies = AppDomain.CurrentDomain.GetOqtaneAssemblies();
foreach (Assembly assembly in assemblies)
foreach (var type in assembly.GetTypes(typeof(ISiteUpgrade)))
{
foreach (var type in assembly.GetTypes().Where(item => item.GetInterfaces().Contains(typeof(IUpgradeable))))
if (Attribute.IsDefined(type, typeof(SiteUpgradeAttribute)))
{
var obj = Activator.CreateInstance(type) as IUpgradeable;
if (obj != null)
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>();
foreach (var alias in aliases.GetAliases().ToList().Where(item => item.IsDefault))
{
foreach (var upgrade in siteupgrades)
{
foreach (var alias in aliases.GetAliases().ToList().Where(item => item.IsDefault))
if (upgrade.Key.StartsWith(alias.Name, StringComparison.OrdinalIgnoreCase))
{
var versions = obj.GetVersions(alias);
if (!string.IsNullOrEmpty(versions))
tenantManager.SetTenant(alias.TenantId);
var site = sites.GetSites().FirstOrDefault(item => item.SiteId == alias.SiteId);
if (site != null)
{
tenantManager.SetTenant(alias.TenantId);
var site = sites.GetSites().FirstOrDefault(item => item.SiteId == alias.SiteId);
if (site != null)
var version = upgrade.Key.Split(' ').Last();
if (string.IsNullOrEmpty(site.Version) || Version.Parse(version) > Version.Parse(site.Version))
{
foreach (var version in versions.Split(',', StringSplitOptions.RemoveEmptyEntries))
try
{
if (string.IsNullOrEmpty(site.Version) || Version.Parse(version) > Version.Parse(site.Version))
var obj = Activator.CreateInstance(upgrade.Value) as ISiteUpgrade;
if (obj.Upgrade(site, alias))
{
if (obj.Upgrade(alias, version))
{
site.Version = version;
sites.UpdateSite(site);
}
else
{
result.Message = "An Error Occurred Executing IUpgradeable Interface For " + alias.Name + " For Version " + version;
}
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
{
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));
}
result.Success = true;
return result;
}

9
Oqtane.Server/Infrastructure/Interfaces/ISiteUpgrade.cs Normal file
View File

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

11
Oqtane.Server/Infrastructure/Interfaces/IUpgradeable.cs
View File

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

27
Oqtane.Server/Infrastructure/Interfaces/SiteUpgradeAttribute.cs Normal file
View File

@ -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; }
}
}
}

37
Oqtane.Server/Infrastructure/SiteUpgrade/ExampleUpgrade.cs
View File

@ -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")]
public class ExampleUpgrade : IUpgradeable
[SiteUpgrade("localhost:44357", "01.00.00")]
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;
break;
}
break;
}
return success;
// execute some version-specific upgrade logic for the site here such as adding pages, modules, content, etc...
return true;
}
}
}