From c70a8ba90f68d91c801d025dc39bc4877f5d1fa2 Mon Sep 17 00:00:00 2001 From: Brian Dukes Date: Tue, 24 Oct 2023 15:47:02 -0500 Subject: [PATCH] Update deprecations for 9.13.1 Deprecate SkinPackageInfo.Skins, rename list to SkinPackageInfo.SkinsList --- .../Library/UI/Skins/SkinController.cs | 42 ++++----- DNN Platform/Library/UI/Skins/SkinInfo.cs | 1 - .../Library/UI/Skins/SkinPackageInfo.cs | 86 ++++++++++++------- 3 files changed, 76 insertions(+), 53 deletions(-) diff --git a/DNN Platform/Library/UI/Skins/SkinController.cs b/DNN Platform/Library/UI/Skins/SkinController.cs index 333762cd476..ab9ff3d3d1b 100644 --- a/DNN Platform/Library/UI/Skins/SkinController.cs +++ b/DNN Platform/Library/UI/Skins/SkinController.cs @@ -39,7 +39,7 @@ public partial class SkinController : ISkinService private static readonly Regex LdirRegex = new Regex("\\[l]", RegexOptions.IgnoreCase | RegexOptions.Compiled); /// - [Obsolete($"Deprecated in DotNetNuke 10.0.0. Use {nameof(SkinType)}.{nameof(ISkinService.GetFolderName)} instead. Scheduled removal in v12.0.0.")] + [Obsolete($"Deprecated in DotNetNuke 9.13.1. Use {nameof(SkinType)}.{nameof(ISkinService.GetFolderName)} instead. Scheduled removal in v12.0.0.")] public static string RootSkin { get @@ -49,7 +49,7 @@ public static string RootSkin } /// - [Obsolete($"Deprecated in DotNetNuke 10.0.0. Use {nameof(SkinType)}.{nameof(ISkinService.GetFolderName)} instead. Scheduled removal in v12.0.0.")] + [Obsolete($"Deprecated in DotNetNuke 9.13.1. Use {nameof(SkinType)}.{nameof(ISkinService.GetFolderName)} instead. Scheduled removal in v12.0.0.")] public static string RootContainer { get @@ -59,21 +59,21 @@ public static string RootContainer } /// - [DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.AddSkin)} instead.")] + [DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.AddSkin)} instead.")] public static partial int AddSkin(int skinPackageID, string skinSrc) { return DataProvider.Instance().AddSkin(skinPackageID, skinSrc); } /// - [DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.AddSkinPackage)} instead.")] + [DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.AddSkinPackage)} instead.")] public static partial int AddSkinPackage(SkinPackageInfo skinPackage) { return AddSkinPackage((ISkinPackageInfo)skinPackage); } /// - [DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.CanDeleteSkinFolder)} instead.")] + [DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.CanDeleteSkinFolder)} instead.")] public static partial bool CanDeleteSkin(string folderPath, string portalHomeDirMapPath) { string skinType; @@ -126,14 +126,14 @@ public static partial bool CanDeleteSkin(string folderPath, string portalHomeDir } /// - [DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.DeleteSkin)} instead.")] + [DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.DeleteSkin)} instead.")] public static partial void DeleteSkin(int skinID) { DataProvider.Instance().DeleteSkin(skinID); } /// - [DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.DeleteSkinPackage)} instead.")] + [DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.DeleteSkinPackage)} instead.")] public static partial void DeleteSkinPackage(SkinPackageInfo skinPackage) { DeleteSkinPackage((ISkinPackageInfo)skinPackage); @@ -167,7 +167,7 @@ public static string FormatMessage(string title, string body, int level, bool is } /// - [DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.FormatSkinPath)} instead.")] + [DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.FormatSkinPath)} instead.")] public static partial string FormatSkinPath(string skinSrc) { string strSkinSrc = skinSrc; @@ -180,7 +180,7 @@ public static partial string FormatSkinPath(string skinSrc) } /// - [DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.FormatSkinSrc)} instead.")] + [DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.FormatSkinSrc)} instead.")] public static partial string FormatSkinSrc(string skinSrc, PortalSettings portalSettings) { return FormatSkinSrc(skinSrc, (IPortalSettings)portalSettings); @@ -192,7 +192,7 @@ public static partial string FormatSkinSrc(string skinSrc, PortalSettings portal /// To get the default admin container for the portal use instead. /// /// The global default admin container. - [DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetDefaultSkinSrc)} instead.")] + [DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetDefaultSkinSrc)} instead.")] public static partial string GetDefaultAdminContainer() { SkinDefaults defaultContainer = SkinDefaults.GetSkinDefaults(SkinDefaultType.ContainerInfo); @@ -205,7 +205,7 @@ public static partial string GetDefaultAdminContainer() /// To get the default admin skin for the portal use instead. /// /// The global default admin skin. - [DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetDefaultSkinSrc)} instead.")] + [DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetDefaultSkinSrc)} instead.")] public static partial string GetDefaultAdminSkin() { SkinDefaults defaultSkin = SkinDefaults.GetSkinDefaults(SkinDefaultType.SkinInfo); @@ -218,7 +218,7 @@ public static partial string GetDefaultAdminSkin() /// To get the default skin for the portal use instead. /// /// The global default skin. - [DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetDefaultSkinSrc)} instead.")] + [DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetDefaultSkinSrc)} instead.")] public static partial string GetDefaultPortalContainer() { SkinDefaults defaultContainer = SkinDefaults.GetSkinDefaults(SkinDefaultType.ContainerInfo); @@ -231,7 +231,7 @@ public static partial string GetDefaultPortalContainer() /// To get the default skin for the portal use instead. /// /// The global default skin. - [DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetDefaultSkinSrc)} instead.")] + [DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetDefaultSkinSrc)} instead.")] public static partial string GetDefaultPortalSkin() { SkinDefaults defaultSkin = SkinDefaults.GetSkinDefaults(SkinDefaultType.SkinInfo); @@ -239,28 +239,28 @@ public static partial string GetDefaultPortalSkin() } /// - [DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetSkinPackageById)} instead.")] + [DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetSkinPackageById)} instead.")] public static partial SkinPackageInfo GetSkinByPackageID(int packageID) { return CBO.FillObject(DataProvider.Instance().GetSkinByPackageID(packageID)); } /// ] - [DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetSkinPackage)} instead.")] + [DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetSkinPackage)} instead.")] public static partial SkinPackageInfo GetSkinPackage(int portalId, string skinName, string skinType) { return CBO.FillObject(DataProvider.Instance().GetSkinPackage(portalId, skinName, skinType)); } /// - [DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetSkinsInFolder)} instead.")] + [DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetSkinsInFolder)} instead.")] public static partial List> GetSkins(PortalInfo portalInfo, string skinRoot, SkinScope scope) { return GetSkins((IPortalInfo)portalInfo, skinRoot, scope); } /// - [DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetSkinsInFolder)} instead.")] + [DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.GetSkinsInFolder)} instead.")] public static partial List> GetSkins(IPortalInfo portalInfo, string skinRoot, SkinScope scope) { var skins = new List>(); @@ -282,14 +282,14 @@ public static partial List> GetSkins(IPortalInfo po } /// - [DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.IsGlobalSkin)} instead.")] + [DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.IsGlobalSkin)} instead.")] public static partial bool IsGlobalSkin(string skinSrc) { return skinSrc.Contains(Globals.HostPath); } /// - [DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.SetSkin)} instead.")] + [DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.SetSkin)} instead.")] public static partial void SetSkin(string skinRoot, int portalId, SkinType skinType, string skinSrc) { var selectedCultureCode = LocaleController.Instance.GetCurrentLocale(portalId).Code; @@ -351,14 +351,14 @@ public static partial void SetSkin(string skinRoot, int portalId, SkinType skinT } /// - [DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.UpdateSkin)} instead.")] + [DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.UpdateSkin)} instead.")] public static partial void UpdateSkin(int skinID, string skinSrc) { DataProvider.Instance().UpdateSkin(skinID, skinSrc); } /// - [DnnDeprecated(10, 0, 0, $"Use {nameof(ISkinService)}.{nameof(ISkinService.UpdateSkin)} instead.")] + [DnnDeprecated(9, 13, 1, $"Use {nameof(ISkinService)}.{nameof(ISkinService.UpdateSkin)} instead.")] public static partial void UpdateSkinPackage(SkinPackageInfo skinPackage) { UpdateSkinPackage((ISkinPackageInfo)skinPackage); diff --git a/DNN Platform/Library/UI/Skins/SkinInfo.cs b/DNN Platform/Library/UI/Skins/SkinInfo.cs index f30ce578026..7095e509bb3 100644 --- a/DNN Platform/Library/UI/Skins/SkinInfo.cs +++ b/DNN Platform/Library/UI/Skins/SkinInfo.cs @@ -6,7 +6,6 @@ namespace DotNetNuke.UI.Skins using System; using DotNetNuke.Abstractions.Skins; - using DotNetNuke.Internal.SourceGenerators; /// Project : DotNetNuke /// Class : SkinInfo diff --git a/DNN Platform/Library/UI/Skins/SkinPackageInfo.cs b/DNN Platform/Library/UI/Skins/SkinPackageInfo.cs index 0635414ed90..a9b54b0cf7d 100644 --- a/DNN Platform/Library/UI/Skins/SkinPackageInfo.cs +++ b/DNN Platform/Library/UI/Skins/SkinPackageInfo.cs @@ -24,53 +24,57 @@ namespace DotNetNuke.UI.Skins [Serializable] public class SkinPackageInfo : BaseEntityInfo, IHydratable, ISkinPackageInfo { - private int packageID = Null.NullInteger; - private int portalID = Null.NullInteger; + private int packageId = Null.NullInteger; + private int portalId = Null.NullInteger; private string skinName; - private int skinPackageID = Null.NullInteger; + private int skinPackageId = Null.NullInteger; private string skinType; - private List skins = new List(); + private Dictionary skins = new Dictionary(); + private List skinsList = new List(); private AbstractionList abstractSkins; /// + [Obsolete($"Deprecated in DotNetNuke 9.13.1. Use {nameof(ISkinPackageInfo)}.{nameof(ISkinPackageInfo.PackageId)} instead. Scheduled for removal in v11.0.0.")] public int PackageID { get { - return this.packageID; + return ((ISkinPackageInfo)this).PackageId; } set { - this.packageID = value; + ((ISkinPackageInfo)this).PackageId = value; } } /// + [Obsolete($"Deprecated in DotNetNuke 9.13.1. Use {nameof(ISkinPackageInfo)}.{nameof(ISkinPackageInfo.SkinPackageId)} instead. Scheduled for removal in v11.0.0.")] public int SkinPackageID { get { - return this.skinPackageID; + return ((ISkinPackageInfo)this).SkinPackageId; } set { - this.skinPackageID = value; + ((ISkinPackageInfo)this).SkinPackageId = value; } } /// + [Obsolete($"Deprecated in DotNetNuke 9.13.1. Use {nameof(ISkinPackageInfo)}.{nameof(ISkinPackageInfo.PortalId)} instead. Scheduled for removal in v11.0.0.")] public int PortalID { get { - return this.portalID; + return ((ISkinPackageInfo)this).PortalId; } set { - this.portalID = value; + ((ISkinPackageInfo)this).PortalId = value; } } @@ -88,10 +92,11 @@ public string SkinName } } - /// + /// Gets or sets a dictionary mapping from to . [XmlIgnore] [JsonIgnore] - public List Skins + [Obsolete($"Deprecated in DotNetNuke 9.13.1. Use {nameof(ISkinPackageInfo)}.{nameof(ISkinPackageInfo.Skins)} instead. Scheduled for removal in v11.0.0.")] + public Dictionary Skins { get { @@ -104,6 +109,22 @@ public List Skins } } + /// + [XmlIgnore] + [JsonIgnore] + public List SkinsList + { + get + { + return this.skinsList; + } + + set + { + this.skinsList = value; + } + } + /// public string SkinType { @@ -123,12 +144,12 @@ public int KeyID { get { - return this.SkinPackageID; + return ((ISkinPackageInfo)this).SkinPackageId; } set { - this.SkinPackageID = value; + ((ISkinPackageInfo)this).SkinPackageId = value; } } @@ -137,8 +158,8 @@ public int KeyID [JsonIgnore] int ISkinPackageInfo.PackageId { - get => this.PackageID; - set => this.PackageID = value; + get => this.packageId; + set => this.packageId = value; } /// @@ -146,8 +167,8 @@ int ISkinPackageInfo.PackageId [JsonIgnore] int ISkinPackageInfo.SkinPackageId { - get => this.SkinPackageID; - set => this.SkinPackageID = value; + get => this.skinPackageId; + set => this.skinPackageId = value; } /// @@ -157,7 +178,7 @@ IObjectList ISkinPackageInfo.Skins { get { - return this.abstractSkins ??= new AbstractionList(this.Skins); + return this.abstractSkins ??= new AbstractionList(this.SkinsList); } } @@ -175,16 +196,17 @@ SkinPackageType ISkinPackageInfo.SkinType [JsonIgnore] int ISkinPackageInfo.PortalId { - get => this.PortalID; - set => this.PortalID = value; + get => this.portalId; + set => this.portalId = value; } /// public void Fill(IDataReader dr) { - this.SkinPackageID = Null.SetNullInteger(dr["SkinPackageID"]); - this.PackageID = Null.SetNullInteger(dr["PackageID"]); - this.SkinName = Null.SetNullString(dr["SkinName"]); + var @this = (ISkinPackageInfo)this; + @this.SkinPackageId = Null.SetNullInteger(dr["SkinPackageID"]); + @this.PackageId = Null.SetNullInteger(dr["PackageID"]); + @this.SkinName = Null.SetNullString(dr["SkinName"]); this.SkinType = Null.SetNullString(dr["SkinType"]); // Call the base classes fill method to populate base class properties @@ -194,15 +216,17 @@ public void Fill(IDataReader dr) { while (dr.Read()) { - int skinID = Null.SetNullInteger(dr["SkinID"]); - if (skinID > Null.NullInteger) + int skinId = Null.SetNullInteger(dr["SkinID"]); + if (skinId > Null.NullInteger) { - this.skins.Add(new SkinInfo + var skinSrc = Null.SetNullString(dr["SkinSrc"]); + this.skins[skinId] = skinSrc; + this.skinsList.Add(new SkinInfo { - SkinId = skinID, - SkinSrc = Null.SetNullString(dr["SkinSrc"]), - SkinPackageId = this.SkinPackageID, - PortalId = this.PortalID, + SkinId = skinId, + SkinSrc = skinSrc, + SkinPackageId = @this.SkinPackageId, + PortalId = @this.PortalId, SkinRoot = SkinUtils.FromDatabaseName(this.SkinType) switch { SkinPackageType.Container => SkinController.RootContainer,