OSOE-818: Upgrade to Orchard Core 2.0

Lombiq.Hosting.MediaTheme.Bridge.Tests.UI/Lombiq.Hosting.MediaTheme.Bridge.Tests.UI.csproj

@@ -27,7 +27,7 @@
     </ItemGroup>
 
     <ItemGroup Condition="'$(NuGetBuild)' == 'true'">
-        <PackageReference Include="Lombiq.Tests.UI" Version="10.0.1" />
+        <PackageReference Include="Lombiq.Tests.UI" Version="11.0.0" />
     </ItemGroup>
 
     <ItemGroup>

Lombiq.Hosting.MediaTheme.Bridge/Controllers/AdminController.cs

@@ -15,7 +15,7 @@
 
 namespace Lombiq.Hosting.MediaTheme.Bridge.Controllers;
 
-public class AdminController : Controller
+public sealed class AdminController : Controller
 {
     private readonly IAuthorizationService _authorizationService;
     private readonly IMediaThemeStateStore _mediaThemeStateStore;

Lombiq.Hosting.MediaTheme.Bridge/Deployment/MediaThemeDeploymentSource.cs

@@ -1,8 +1,9 @@
 using Lombiq.Hosting.MediaTheme.Bridge.Constants;
 using Lombiq.Hosting.MediaTheme.Bridge.Models;
 using Lombiq.Hosting.MediaTheme.Bridge.Services;
-using Newtonsoft.Json.Linq;
 using OrchardCore.Deployment;
+using System.Collections.Generic;
+using System.Text.Json.Nodes;
 using System.Threading.Tasks;
 
 namespace Lombiq.Hosting.MediaTheme.Bridge.Deployment;
@@ -23,10 +24,11 @@ public async Task ProcessDeploymentStepAsync(DeploymentStep step, DeploymentPlan
 
         var mediaThemeState = await _mediaThemeStateStore.GetMediaThemeStateAsync();
 
-        result.Steps.Add(new JObject(
-            new JProperty("name", RecipeStepIds.MediaTheme),
-            new JProperty(nameof(MediaThemeDeploymentStep.ClearMediaThemeFolder), mediaThemeStep.ClearMediaThemeFolder),
-            new JProperty(nameof(MediaThemeStateDocument.BaseThemeId), mediaThemeState.BaseThemeId)
-        ));
+        result.Steps.Add(new JsonObject(new Dictionary<string, JsonNode>
+        {
+            ["name"] = RecipeStepIds.MediaTheme,
+            [nameof(MediaThemeDeploymentStep.ClearMediaThemeFolder)] = mediaThemeStep.ClearMediaThemeFolder,
+            [nameof(MediaThemeStateDocument.BaseThemeId)] = mediaThemeState.BaseThemeId,
+        }));
     }
 }

Lombiq.Hosting.MediaTheme.Bridge/Deployment/MediaThemeDeploymentStepDriver.cs

@@ -1,30 +1,31 @@
 using Lombiq.Hosting.MediaTheme.Bridge.ViewModels;
 using OrchardCore.Deployment;
 using OrchardCore.DisplayManagement.Handlers;
-using OrchardCore.DisplayManagement.ModelBinding;
 using OrchardCore.DisplayManagement.Views;
 using System.Threading.Tasks;
+using static Lombiq.HelpfulLibraries.OrchardCore.Contents.CommonContentDisplayTypes;
+using static Lombiq.HelpfulLibraries.OrchardCore.Contents.CommonLocationNames;
 
 namespace Lombiq.Hosting.MediaTheme.Bridge.Deployment;
 
-public class MediaThemeDeploymentStepDriver : DisplayDriver<DeploymentStep, MediaThemeDeploymentStep>
+public sealed class MediaThemeDeploymentStepDriver : DisplayDriver<DeploymentStep, MediaThemeDeploymentStep>
 {
-    public override IDisplayResult Display(MediaThemeDeploymentStep model) =>
+    public override IDisplayResult Display(MediaThemeDeploymentStep model, BuildDisplayContext context) =>
         Combine(
-            View($"{nameof(MediaThemeDeploymentStep)}_Fields_Summary", model).Location("Summary", "Content"),
-            View($"{nameof(MediaThemeDeploymentStep)}_Fields_Thumbnail", model).Location("Thumbnail", "Content")
+            View($"{nameof(MediaThemeDeploymentStep)}_Fields_Summary", model).Location(Summary, Content),
+            View($"{nameof(MediaThemeDeploymentStep)}_Fields_Thumbnail", model).Location(Thumbnail, Content)
         );
 
-    public override IDisplayResult Edit(MediaThemeDeploymentStep model) =>
+    public override IDisplayResult Edit(MediaThemeDeploymentStep model, BuildEditorContext context) =>
         Initialize<MediaThemeDeploymentStepViewModel>(
             $"{nameof(MediaThemeDeploymentStep)}_Fields_Edit",
             viewModel => viewModel.ClearMediaThemeFolder = model.ClearMediaThemeFolder)
-        .Location("Content");
+        .Location(Content);
 
-    public override async Task<IDisplayResult> UpdateAsync(MediaThemeDeploymentStep model, IUpdateModel updater)
+    public override async Task<IDisplayResult> UpdateAsync(MediaThemeDeploymentStep model, UpdateEditorContext context)
     {
-        await updater.TryUpdateModelAsync(model, Prefix, viewModel => viewModel.ClearMediaThemeFolder);
+        await context.Updater.TryUpdateModelAsync(model, Prefix, viewModel => viewModel.ClearMediaThemeFolder);
 
-        return Edit(model);
+        return await EditAsync(model, context);
     }
 }

Lombiq.Hosting.MediaTheme.Bridge/Lombiq.Hosting.MediaTheme.Bridge.csproj

@@ -27,21 +27,23 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="OrchardCore.Deployment.Abstractions" Version="1.8.0" />
-    <PackageReference Include="OrchardCore.DisplayManagement.Abstractions" Version="1.8.0" />
-    <PackageReference Include="OrchardCore.Recipes.Abstractions" Version="1.8.0" />
-    <PackageReference Include="OrchardCore.ResourceManagement.Abstractions" Version="1.8.0" />
-    <PackageReference Include="OrchardCore.Media" Version="1.8.0" />
-    <PackageReference Include="OrchardCore.Module.Targets" Version="1.8.0" />
+    <PackageReference Include="OrchardCore.Deployment.Abstractions" Version="2.0.0" />
+    <PackageReference Include="OrchardCore.DisplayManagement.Abstractions" Version="2.0.0" />
+    <PackageReference Include="OrchardCore.Recipes.Abstractions" Version="2.0.0" />
+    <PackageReference Include="OrchardCore.ResourceManagement.Abstractions" Version="2.0.0" />
+    <PackageReference Include="OrchardCore.Media" Version="2.0.0" />
+    <PackageReference Include="OrchardCore.Module.Targets" Version="2.0.0" />
     <PackageReference Include="Scrutor" Version="4.2.2" />
   </ItemGroup>
 
   <ItemGroup Condition="'$(NuGetBuild)' != 'true'">
     <ProjectReference Include="..\..\..\Libraries\Lombiq.HelpfulLibraries\Lombiq.HelpfulLibraries.OrchardCore\Lombiq.HelpfulLibraries.OrchardCore.csproj" />
+    <ProjectReference Include="..\..\..\Modules\Lombiq.HelpfulExtensions\Lombiq.HelpfulExtensions\Lombiq.HelpfulExtensions.csproj" />
   </ItemGroup>
 
   <ItemGroup Condition="'$(NuGetBuild)' == 'true'">
-    <PackageReference Include="Lombiq.HelpfulLibraries.OrchardCore" Version="10.0.0" />
+    <PackageReference Include="Lombiq.HelpfulLibraries.OrchardCore" Version="11.0.0" />
+    <PackageReference Include="Lombiq.HelpfulExtensions" Version="9.0.0" />
   </ItemGroup>
 
 </Project>

Lombiq.Hosting.MediaTheme.Bridge/Manifest.cs

@@ -1,3 +1,4 @@
+using Lombiq.HelpfulExtensions;
 using OrchardCore.Modules.Manifest;
 
 [assembly: Module(
@@ -7,5 +8,5 @@
     Version = "0.0.1",
     Description = "Provides the processing logic for the Media Theme.",
     Category = "Hosting",
-    Dependencies = ["OrchardCore.Deployment", "OrchardCore.Media"]
+    Dependencies = ["OrchardCore.Deployment", "OrchardCore.Media", FeatureIds.GoogleTag]
 )]

Lombiq.Hosting.MediaTheme.Bridge/Middlewares/BlockMediaThemeTemplateDirectAccessMiddleware.cs

@@ -1,6 +1,7 @@
 using Lombiq.Hosting.MediaTheme.Bridge.Constants;
 using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.Options;
+using Microsoft.Net.Http.Headers;
 using OrchardCore.Media;
 using OrchardCore.Routing;
 using System;
@@ -37,8 +38,8 @@ public async Task InvokeAsync(HttpContext context)
             return;
         }
 
-        context.Response.StatusCode = 404;
-        context.Response.Headers.Append("Content-Length", "0");
+        context.Response.StatusCode = StatusCodes.Status404NotFound;
+        context.Response.Headers.Append(HeaderNames.ContentLength, "0");
         await context.Response.Body.FlushAsync(context.RequestAborted);
         // Use Complete instead of Abort which actually causes a 502 Bad Gateway response.
         await context.Response.CompleteAsync();

Lombiq.Hosting.MediaTheme.Bridge/Navigation/MediaThemeDeploymentSettingsAdminMenu.cs

@@ -7,15 +7,15 @@
 
 namespace Lombiq.Hosting.MediaTheme.Bridge.Navigation;
 
-public class MediaThemeDeploymentSettingsAdminMenu : INavigationProvider
+public sealed class MediaThemeDeploymentSettingsAdminMenu : INavigationProvider
 {
     private readonly IStringLocalizer T;
 
     public MediaThemeDeploymentSettingsAdminMenu(IStringLocalizer<MediaThemeDeploymentSettingsAdminMenu> stringLocalizer) => T = stringLocalizer;
 
-    public Task BuildNavigationAsync(string name, NavigationBuilder builder)
+    public ValueTask BuildNavigationAsync(string name, NavigationBuilder builder)
     {
-        if (!string.Equals(name, "admin", StringComparison.OrdinalIgnoreCase)) return Task.CompletedTask;
+        if (!string.Equals(name, "admin", StringComparison.OrdinalIgnoreCase)) return ValueTask.CompletedTask;
 
         builder
             .Add(T["Configuration"], configuration => configuration
@@ -25,6 +25,6 @@ public Task BuildNavigationAsync(string name, NavigationBuilder builder)
                     .Permission(ManageMediaTheme)
                     .LocalNav()));
 
-        return Task.CompletedTask;
+        return ValueTask.CompletedTask;
     }
 }

Lombiq.Hosting.MediaTheme.Bridge/Permissions/MediaThemeDeploymentPermissions.cs

@@ -5,7 +5,7 @@
 
 namespace Lombiq.Hosting.MediaTheme.Bridge.Permissions;
 
-public class MediaThemeDeploymentPermissions : IPermissionProvider
+public sealed class MediaThemeDeploymentPermissions : IPermissionProvider
 {
     public static readonly Permission ManageMediaTheme = new(
         nameof(ManageMediaTheme),

Lombiq.Hosting.MediaTheme.Bridge/Services/ExtensionManagerDecorator.cs

@@ -8,7 +8,7 @@
 
 namespace Lombiq.Hosting.MediaTheme.Bridge.Services;
 
-public class ExtensionManagerDecorator : IExtensionManager
+public sealed class ExtensionManagerDecorator : IExtensionManager
 {
     private readonly IExtensionManager _decorated;
     private readonly IMediaThemeStateStore _mediaThemeStateStore;
@@ -68,13 +68,13 @@ public IEnumerable<IFeatureInfo> GetFeatures(string[] featureIdsToLoad)
     public IEnumerable<IFeatureInfo> GetDependentFeatures(string featureId) =>
         _decorated.GetDependentFeatures(featureId);
 
-    public Task<IEnumerable<FeatureEntry>> LoadFeaturesAsync() =>
+    Task<IEnumerable<IFeatureInfo>> IExtensionManager.LoadFeaturesAsync() =>
         _decorated.LoadFeaturesAsync();
 
-    public Task<IEnumerable<FeatureEntry>> LoadFeaturesAsync(string[] featureIdsToLoad) =>
+    Task<IEnumerable<IFeatureInfo>> IExtensionManager.LoadFeaturesAsync(string[] featureIdsToLoad) =>
         _decorated.LoadFeaturesAsync(featureIdsToLoad);
 
     private string GetBaseThemeId() =>
-        // It'll be retrieved from cache so it's not an issue.
+        // It'll be retrieved from cache, so it's not an issue.
         _mediaThemeStateStore.GetMediaThemeStateAsync().GetAwaiter().GetResult()?.BaseThemeId;
 }

Lombiq.Hosting.MediaTheme.Bridge/Services/MediaTemplatesShapeBindingResolver.cs

@@ -1,7 +1,9 @@
-using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Html;
+using Microsoft.AspNetCore.Http;
 using OrchardCore.Admin;
 using OrchardCore.DisplayManagement;
 using OrchardCore.DisplayManagement.Descriptors;
+using OrchardCore.DisplayManagement.Implementation;
 using OrchardCore.Liquid;
 using System.Text.Encodings.Web;
 using System.Threading.Tasks;
@@ -27,27 +29,20 @@ public MediaTemplatesShapeBindingResolver(
         _mediaThemeCachingService = mediaThemeCachingService;
     }
 
-    public async Task<ShapeBinding> GetShapeBindingAsync(string shapeType)
-    {
-        if (AdminAttribute.IsApplied(_hca.HttpContext))
-        {
-            return null;
-        }
+    public async Task<ShapeBinding> GetShapeBindingAsync(string shapeType) =>
+        !AdminAttribute.IsApplied(_hca.HttpContext) &&
+        await _mediaThemeCachingService.GetMemoryCachedMediaTemplateAsync(shapeType) is { } mediaTemplate
+            ? new()
+            {
+                BindingName = shapeType,
+                BindingSource = shapeType,
+                BindingAsync = displayContext => BindingAsync(displayContext, mediaTemplate.Content),
+            }
+            : null;
 
-        return await _mediaThemeCachingService.GetMemoryCachedMediaTemplateAsync(shapeType) is not { } mediaTemplate
-            ? null
-            : BuildShapeBinding(shapeType, mediaTemplate.Content);
+    private async Task<IHtmlContent> BindingAsync(DisplayContext displayContext, string text)
+    {
+        var content = await _liquidTemplateManager.RenderHtmlContentAsync(text, _htmlEncoder, displayContext.Value);
+        return content;
     }
-
-    private ShapeBinding BuildShapeBinding(string shapeType, string text) =>
-        new()
-        {
-            BindingName = shapeType,
-            BindingSource = shapeType,
-            BindingAsync = async displayContext =>
-            {
-                var content = await _liquidTemplateManager.RenderHtmlContentAsync(text, _htmlEncoder, displayContext.Value);
-                return content;
-            },
-        };
 }

Lombiq.Hosting.MediaTheme.Bridge/Services/MediaThemeManager.cs

@@ -17,6 +17,8 @@ namespace Lombiq.Hosting.MediaTheme.Bridge.Services;
 
 public class MediaThemeManager : IMediaThemeManager
 {
+    private const string LiquidExtension = ".liquid";
+
     private readonly IMediaThemeStateStore _mediaThemeStateStore;
     private readonly IShellFeaturesManager _shellFeaturesManager;
     private readonly IMemoryCache _memoryCache;
@@ -77,11 +79,20 @@ public async Task UpdateBaseThemeAsync(string baseThemeId)
 
     public async Task<MediaTemplate> GetMediaTemplateByShapeTypeAsync(string shapeType)
     {
-        var templatePath = _mediaFileStore.Combine(
-            Paths.MediaThemeRootFolder,
-            Paths.MediaThemeTemplatesFolder,
-            shapeType + ".liquid");
-        if (!await _mediaFileStore.FileExistsAsync(templatePath)) return null;
+        var templatePath = GetPath(shapeType + LiquidExtension);
+
+        // Check if the file exists with a different casing, before giving up.
+        if (!await _mediaFileStore.FileExistsAsync(templatePath))
+        {
+            var basePath = GetPath();
+            var file = await _mediaFileStore
+                .GetDirectoryContentAsync(basePath)
+                .Where(file => file.Name.EqualsOrdinalIgnoreCase(shapeType + LiquidExtension))
+                .FirstOrDefaultAsync();
+
+            if (file == null) return null;
+            templatePath = GetPath(file.Name);
+        }
 
         await using var templateFileStream = await _mediaFileStore.GetFileStreamAsync(templatePath);
         using var reader = new StreamReader(templateFileStream);
@@ -95,6 +106,11 @@ public async Task<MediaTemplate> GetMediaTemplateByShapeTypeAsync(string shapeTy
         };
     }
 
+    private string GetPath(string shapeType = null) =>
+        shapeType == null
+            ? _mediaFileStore.Combine(Paths.MediaThemeRootFolder, Paths.MediaThemeTemplatesFolder)
+            : _mediaFileStore.Combine(Paths.MediaThemeRootFolder, Paths.MediaThemeTemplatesFolder, shapeType);
+
     private static void ThrowIfBaseThemeIdIsInvalid(string baseThemeId)
     {
         if (baseThemeId == FeatureNames.MediaTheme)

Lombiq.Hosting.MediaTheme.Bridge/Services/MediaThemeStep.cs

@@ -4,11 +4,12 @@
 using OrchardCore.Recipes.Models;
 using OrchardCore.Recipes.Services;
 using System;
+using System.Text.Json;
 using System.Threading.Tasks;
 
 namespace Lombiq.Hosting.MediaTheme.Bridge.Services;
 
-public class MediaThemeStep : IRecipeStepHandler
+public sealed class MediaThemeStep : IRecipeStepHandler
 {
     private readonly IMediaFileStore _mediaFileStore;
     private readonly IMediaThemeManager _mediaThemeManager;
@@ -28,7 +29,7 @@ public async Task ExecuteAsync(RecipeExecutionContext context)
             return;
         }
 
-        var model = context.Step.ToObject<MediaThemeStepModel>();
+        var model = context.Step.Deserialize<MediaThemeStepModel>();
 
         await _mediaThemeManager.UpdateBaseThemeAsync(model.BaseThemeId);
 

Lombiq.Hosting.MediaTheme.Bridge/Startup.cs

@@ -11,7 +11,6 @@
 using Microsoft.Extensions.DependencyInjection;
 using OrchardCore.Deployment;
 using OrchardCore.DisplayManagement;
-using OrchardCore.DisplayManagement.Handlers;
 using OrchardCore.Environment.Extensions;
 using OrchardCore.Modules;
 using OrchardCore.Navigation;
@@ -21,23 +20,21 @@
 
 namespace Lombiq.Hosting.MediaTheme.Bridge;
 
-public class Startup : StartupBase
+public sealed class Startup : StartupBase
 {
-    // Make sure the middlewares run first so we can block Media Theme template requests in time.
-    public override int Order => -100;
+    // Make sure the middlewares run first, so we can block Media Theme template requests in time.
+    public override int ConfigureOrder => int.MinValue;
 
     public override void ConfigureServices(IServiceCollection services)
     {
-        services.AddScoped<IPermissionProvider, MediaThemeDeploymentPermissions>();
-        services.AddScoped<INavigationProvider, MediaThemeDeploymentSettingsAdminMenu>();
+        services.AddPermissionProvider<MediaThemeDeploymentPermissions>();
+        services.AddNavigationProvider<MediaThemeDeploymentSettingsAdminMenu>();
         services.AddSingleton<IMediaThemeStateStore, MediaThemeStateStore>();
         services.Decorate<IExtensionManager, ExtensionManagerDecorator>();
         services.AddScoped<IShapeBindingResolver, MediaTemplatesShapeBindingResolver>();
         services.AddScoped<IMediaThemeManager, MediaThemeManager>();
         services.AddRecipeExecutionStep<MediaThemeStep>();
-        services.AddTransient<IDeploymentSource, MediaThemeDeploymentSource>();
-        services.AddSingleton<IDeploymentStepFactory>(new DeploymentStepFactory<MediaThemeDeploymentStep>());
-        services.AddScoped<IDisplayDriver<DeploymentStep>, MediaThemeDeploymentStepDriver>();
+        services.AddDeployment<MediaThemeDeploymentSource, MediaThemeDeploymentStep, MediaThemeDeploymentStepDriver>();
         services.AddScoped<IAuthorizationHandler, ManageMediaThemeFolderAuthorizationHandler>();
         services.AddScoped<IMediaThemeCachingService, MediaThemeCachingService>();
         services.AddOrchardServices();

Lombiq.Hosting.MediaTheme.Deployer/Lombiq.Hosting.MediaTheme.Deployer.csproj

@@ -24,7 +24,6 @@
 
   <ItemGroup>
     <PackageReference Include="CommandLineParser" Version="2.9.1" />
-    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
   </ItemGroup>
 
   <ItemGroup>