Introduce IHostSettings to replace Host class by bdukes · Pull Request #6538 · dnnsoftware/Dnn.Platform

bdukes · 2025-05-02T19:27:29Z

Summary

In order to resolve usages of the deprecated HostController.Instance in DotNetNuke.Entities.Host.Host, this PR introduces DotNetNuke.Abstractions.Application.IHostSettings and its default implementation DotNetNuke.Entities.Host.HostSettings. This included creating a copy of the PerformanceSettings and SchedulerMode enums inside DotNetNuke.Abstractions, as well as extracting IFileExtensionAllowList from the FileExtensionWhitelist class.

IHostSettings differs from the old Host class in a few ways.

All of the SMTP properties take a portalId parameter, rather than implicitly using the current portal context.
Some of the return types are changed from int to TimeSpan to make date math easier and less error prone.
Casing has been normalized (e.g. Guid instead of GUID, HostPortalId instead of HostPortalID)

valadas

Posted a few questions...

DNN Platform/Dnn.AuthServices.Jwt/Data/DataService.cs

DNN Platform/DotNetNuke.Abstractions/Application/IHostSettings.cs

DNN Platform/DotNetNuke.Web/InternalServices/FileUploadController.cs

DNN Platform/Website/Default.aspx.cs

Dnn.AdminExperience/EditBar/Dnn.EditBar.UI/Services/CommonController.cs

bdukes · 2025-05-05T17:48:24Z

I've pushed resolutions to all of your questions @valadas

valadas

Cought 2 more little fallbacks missing and one more question, but looks great!

DNN Platform/Library/Framework/JavaScriptLibraries/JavaScript.cs

DNN Platform/Website/DesktopModules/Admin/Security/User.ascx.cs

DNN Platform/Website/admin/Containers/Toggle.ascx.cs

valadas

Nothing sticks out from the code however when I run DNN from this CI build I get the following error in Pages and Theme (persona bar modules)

2025-05-06 13:29:37.491-04:00 [DanielValadasPC][D:6][T:35][ERROR] DotNetNuke.Services.Exceptions.Exceptions - System.NullReferenceException: Object reference not set to an instance of an object.
   at DotNetNuke.UI.Skins.SkinController.CanDeleteSkin(IHostSettings hostSettings, String folderPath, String portalHomeDirMapPath)
   at Dnn.PersonaBar.Themes.Components.ThemesController.GetThemes(ThemeType type, String strRoot)
   at Dnn.PersonaBar.Themes.Components.ThemesController.GetLayouts(PortalSettings portalSettings, ThemeLevel level)
   at Dnn.PersonaBar.Themes.Components.ThemesController.GetThemeFile(PortalSettings portalSettings, String filePath, ThemeType type)
   at Dnn.PersonaBar.Pages.Components.Converters.ConvertToPageSettings[T](TabInfo tab)
   at Dnn.PersonaBar.Pages.Components.PagesControllerImpl.GetPageSettings(Int32 pageId, PortalSettings requestPortalSettings)
   at Dnn.PersonaBar.Pages.Services.PagesController.GetPageDetails(Int32 pageId)
   at lambda_method(Closure , Object , Object[] )
   at System.Web.Http.Controllers.ReflectedHttpActionDescriptor.ActionExecutor.<>c__DisplayClass6_0.<GetExecutor>b__2(Object instance, Object[] methodParameters)
   at System.Web.Http.Controllers.ReflectedHttpActionDescriptor.ExecuteAsync(HttpControllerContext controllerContext, IDictionary`2 arguments, CancellationToken cancellationToken)
--- End of stack trace from previous location where exception was thrown ---
   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
   at System.Web.Http.Tracing.ITraceWriterExtensions.<TraceBeginEndAsyncCore>d__17`1.MoveNext()
--- End of stack trace from previous location where exception was thrown ---
   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
   at System.Web.Http.Controllers.ApiControllerActionInvoker.<InvokeActionAsyncCore>d__1.MoveNext()
--- End of stack trace from previous location where exception was thrown ---
   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
   at System.Web.Http.Tracing.ITraceWriterExtensions.<TraceBeginEndAsyncCore>d__17`1.MoveNext()
--- End of stack trace from previous location where exception was thrown ---
   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
   at System.Web.Http.Controllers.ActionFilterResult.<ExecuteAsync>d__5.MoveNext()
--- End of stack trace from previous location where exception was thrown ---
   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
   at System.Web.Http.Filters.AuthorizationFilterAttribute.<ExecuteAuthorizationFilterAsyncCore>d__3.MoveNext()
--- End of stack trace from previous location where exception was thrown ---
   at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
   at System.Web.Http.Controllers.ExceptionFilterResult.<ExecuteAsync>d__6.MoveNext()

bdukes · 2025-05-06T17:36:01Z

I found the issue (a missed hostSettings ??= Globals.GetCurrentServiceProvider().GetRequiredService<IHostSettings>(); line), I've pushed a fixed version. Thanks for testing.

valadas · 2025-05-06T17:38:53Z

I found the issue (a missed hostSettings ??= Globals.GetCurrentServiceProvider().GetRequiredService<IHostSettings>(); line), I've pushed a fixed version. Thanks for testing.

You are welcome, thanks for doing lol...
I'll retest when CI is finished.

valadas · 2025-05-06T18:17:35Z

I found the issue (a missed hostSettings ??= Globals.GetCurrentServiceProvider().GetRequiredService<IHostSettings>(); line), I've pushed a fixed version. Thanks for testing.

Just retested, looks like it worked for the Pages module but not the Themes module

valadas · 2025-05-06T18:21:19Z

It may however be a different issue, I see nothing in the log4net logs and I get this in the browswer:
No service for type 'DotNetNuke.Services.Localization.ILocaleController' has been registered.

valadas · 2025-05-06T18:23:18Z

Also in the extensions module I get An error occurred when trying to create a controller of type 'ExtensionsController'. Make sure that the controller has a parameterless public constructor.

bdukes · 2025-05-06T18:43:24Z

It may however be a different issue, I see nothing in the log4net logs and I get this in the browswer: No service for type 'DotNetNuke.Services.Localization.ILocaleController' has been registered.

I just pushed a fix for the Themes extension (which was trying to use ILocaleController via DI, but it wasn't registered).

bdukes · 2025-05-06T18:44:07Z

Also in the extensions module I get An error occurred when trying to create a controller of type 'ExtensionsController'. Make sure that the controller has a parameterless public constructor.

I made a small change to ExtensionsController, but I'll need to look closer at this. It does have a parameterless public controller…

bdukes · 2025-05-06T22:03:02Z

I've fixed ExtensionsController (IPortalAliasController needed to be added to the DI container)

GerardSmit

I saw this PR and had some small feedback/questions 😊

DNN Platform/DotNetNuke.Abstractions/Application/IHostSettings.cs

DNN Platform/DotNetNuke.Abstractions/Application/SchedulerMode.cs

valadas

2 more small things

DNN Platform/DotNetNuke.Abstractions/Application/SchedulerMode.cs

DNN Platform/Website/Default.aspx.cs

valadas

Nothing sticks out to me anymore, looks great! I tested a clean install and all the PB modules appear to be showing the right info. Nice!

Due to change from 0fe4a53

Replace static dependencies from JavaScript class

Dnn.AdminExperience/Dnn.PersonaBar.Extensions/Components/Prompt/Models/HostModel.cs Dnn.AdminExperience/Dnn.PersonaBar.Extensions/Services/ThemesController.cs

david-poindexter

Looks great!

bdukes added the Type: Maintenance label May 2, 2025

bdukes added this to the 10.0.2 milestone May 2, 2025

bdukes force-pushed the host-settings branch from 3344ca8 to 2566c99 Compare May 2, 2025 20:51

valadas reviewed May 3, 2025

View reviewed changes

bdukes force-pushed the host-settings branch 3 times, most recently from a794088 to 6a18504 Compare May 5, 2025 16:57

bdukes force-pushed the host-settings branch from 6a18504 to 15e27e6 Compare May 5, 2025 22:01

valadas requested changes May 6, 2025

View reviewed changes

DNN Platform/Library/Framework/JavaScriptLibraries/JavaScript.cs Show resolved Hide resolved

DNN Platform/Website/DesktopModules/Admin/Security/User.ascx.cs Outdated Show resolved Hide resolved

DNN Platform/Website/admin/Containers/Toggle.ascx.cs Outdated Show resolved Hide resolved

bdukes force-pushed the host-settings branch 2 times, most recently from eb5868d to 4cdb886 Compare May 6, 2025 13:05

bdukes requested a review from valadas May 6, 2025 15:28

valadas requested changes May 6, 2025

View reviewed changes

bdukes force-pushed the host-settings branch from db77b60 to ad68c00 Compare May 6, 2025 17:35

bdukes force-pushed the host-settings branch from ad68c00 to 06001a4 Compare May 6, 2025 18:42

bdukes force-pushed the host-settings branch from 06001a4 to 7395be1 Compare May 6, 2025 21:42

GerardSmit reviewed May 7, 2025

View reviewed changes

bdukes force-pushed the host-settings branch from cd7512b to 805395d Compare May 8, 2025 14:00

valadas requested changes May 13, 2025

View reviewed changes

DNN Platform/DotNetNuke.Abstractions/Application/SchedulerMode.cs Show resolved Hide resolved

DNN Platform/Website/Default.aspx.cs Show resolved Hide resolved

bdukes force-pushed the host-settings branch from 805395d to 853d2bc Compare May 13, 2025 13:12

bdukes requested a review from valadas May 13, 2025 13:13

valadas approved these changes May 13, 2025

View reviewed changes

bdukes added 15 commits May 20, 2025 14:17

Fix verified generated code

b0533dd

Due to change from 0fe4a53

Add IHostSettings abstraction

4db8846

Use IHostSettings instead of Host in some places

82c4ec7

Add IJavaScriptLibraryHelper

f8a64c7

Replace static dependencies from JavaScript class

Replace usages of Host.CheckUpgrade

e181d55

Replace usages of Host.ControlPanel

bd8b52d

Replace usages of Host.DisableEditBar

b35a77d

Replace usages of Host.CrmVersion

e9ad602

Replace usages of Host.DefaultAdminContainer

db396d0

Dnn.AdminExperience/Dnn.PersonaBar.Extensions/Components/Prompt/Models/HostModel.cs Dnn.AdminExperience/Dnn.PersonaBar.Extensions/Services/ThemesController.cs

Fix tests

6440f2a

Replace usage of Host.DefaultDocType

e0620ef

Replace usage of Host.DefaultPortalSkin

3462de0

Make enum name with underscore not browsable

98f6345

Add CacheControlHeader enum for cacheability

098f830

Extract IMailSettings

e0f2d3a

bdukes force-pushed the host-settings branch from 853d2bc to e0f2d3a Compare May 20, 2025 19:17

valadas approved these changes May 20, 2025

View reviewed changes

david-poindexter approved these changes May 25, 2025

View reviewed changes

david-poindexter merged commit 4f20ac1 into dnnsoftware:develop May 25, 2025
3 checks passed

david-poindexter deleted the host-settings branch May 25, 2025 05:26

bdukes mentioned this pull request Jul 8, 2025

Remove implicit dependencies in PortalController #6602

Merged

valadas modified the milestones: 10.0.2, 10.1.0 Jul 30, 2025

Uh oh!

Conversation

bdukes commented May 2, 2025

Summary

Uh oh!

valadas left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bdukes commented May 5, 2025

Uh oh!

valadas left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

valadas left a comment

Choose a reason for hiding this comment

Uh oh!

bdukes commented May 6, 2025

Uh oh!

valadas commented May 6, 2025

Uh oh!

valadas commented May 6, 2025

Uh oh!

valadas commented May 6, 2025

Uh oh!

valadas commented May 6, 2025

Uh oh!

bdukes commented May 6, 2025

Uh oh!

bdukes commented May 6, 2025

Uh oh!

bdukes commented May 6, 2025

Uh oh!

GerardSmit left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

valadas left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

valadas left a comment

Choose a reason for hiding this comment

Uh oh!

david-poindexter left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants