Sitemap deployment plans and recipes

src/OrchardCore.Modules/OrchardCore.Sitemaps/Deployment/AllSitemapsDeploymentSource.cs

@@ -0,0 +1,40 @@
+using System.Threading.Tasks;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+using OrchardCore.Deployment;
+using OrchardCore.Sitemaps.Services;
+
+namespace OrchardCore.Sitemaps.Deployment
+{
+    public class AllSitemapsDeploymentSource : IDeploymentSource
+    {
+        private static readonly JsonSerializer Serializer = new JsonSerializer()
+        {
+            TypeNameHandling = TypeNameHandling.Auto
+        };
+
+        private readonly ISitemapManager _sitemapManager;
+
+        public AllSitemapsDeploymentSource(ISitemapManager sitemapManager)
+        {
+            _sitemapManager = sitemapManager;
+        }
+
+        public async Task ProcessDeploymentStepAsync(DeploymentStep step, DeploymentPlanResult result)
+        {
+            if (!(step is AllSitemapsDeploymentStep))
+            {
+                return;
+            }
+
+            var sitemaps = await _sitemapManager.GetSitemapsAsync();
+
+            var jArray = JArray.FromObject(sitemaps, Serializer);
+
+            result.Steps.Add(new JObject(
+                new JProperty("name", "Sitemaps"),
+                new JProperty("data", jArray)
+            ));
+        }
+    }
+}

src/OrchardCore.Modules/OrchardCore.Sitemaps/Deployment/AllSitemapsDeploymentStep.cs

@@ -0,0 +1,12 @@
+using OrchardCore.Deployment;
+
+namespace OrchardCore.Sitemaps.Deployment
+{
+    public class AllSitemapsDeploymentStep : DeploymentStep
+    {
+        public AllSitemapsDeploymentStep()
+        {
+            Name = "AllSitemaps";
+        }
+    }
+}

src/OrchardCore.Modules/OrchardCore.Sitemaps/Deployment/AllSitemapsDeploymentStepDriver.cs

@@ -0,0 +1,23 @@
+using OrchardCore.Deployment;
+using OrchardCore.DisplayManagement.Handlers;
+using OrchardCore.DisplayManagement.Views;
+
+namespace OrchardCore.Sitemaps.Deployment
+{
+    public class AllSitemapsDeploymentStepDriver : DisplayDriver<DeploymentStep, AllSitemapsDeploymentStep>
+    {
+        public override IDisplayResult Display(AllSitemapsDeploymentStep step)
+        {
+            return
+                Combine(
+                    View("AllSitemapsDeploymentStep_Summary", step).Location("Summary", "Content"),
+                    View("AllSitemapsDeploymentStep_Thumbnail", step).Location("Thumbnail", "Content")
+                );
+        }
+
+        public override IDisplayResult Edit(AllSitemapsDeploymentStep step)
+        {
+            return View("AllSitemapsDeploymentStep_Edit", step).Location("Content");
+        }
+    }
+}

src/OrchardCore.Modules/OrchardCore.Sitemaps/OrchardCore.Sitemaps.csproj

@@ -19,6 +19,7 @@
     <ProjectReference Include="..\..\OrchardCore\OrchardCore.ContentManagement.Abstractions\OrchardCore.ContentManagement.Abstractions.csproj" />
     <ProjectReference Include="..\..\OrchardCore\OrchardCore.ContentTypes.Abstractions\OrchardCore.ContentTypes.Abstractions.csproj" />
     <ProjectReference Include="..\..\OrchardCore\OrchardCore.Data.Abstractions\OrchardCore.Data.Abstractions.csproj" />
+    <ProjectReference Include="..\..\OrchardCore\OrchardCore.Deployment.Abstractions\OrchardCore.Deployment.Abstractions.csproj" />
     <ProjectReference Include="..\..\OrchardCore\OrchardCore.Liquid.Abstractions\OrchardCore.Liquid.Abstractions.csproj" />
     <ProjectReference Include="..\..\OrchardCore\OrchardCore.Module.Targets\OrchardCore.Module.Targets.csproj" />
     <ProjectReference Include="..\..\OrchardCore\OrchardCore.Navigation.Core\OrchardCore.Navigation.Core.csproj" />

src/OrchardCore.Modules/OrchardCore.Sitemaps/Recipes/SitemapsStep.cs

@@ -0,0 +1,50 @@
+using System;
+using System.Threading.Tasks;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+using OrchardCore.Recipes.Models;
+using OrchardCore.Recipes.Services;
+using OrchardCore.Sitemaps.Models;
+using OrchardCore.Sitemaps.Services;
+
+namespace OrchardCore.Sitemaps.Recipes
+{
+    /// <summary>
+    /// This recipe step creates a set of sitemaps.
+    /// </summary>
+    public class SitemapsStep : IRecipeStepHandler
+    {
+        private static readonly JsonSerializer Serializer = new JsonSerializer()
+        {
+            TypeNameHandling = TypeNameHandling.Auto
+        };
+
+        private readonly ISitemapManager _sitemapManager;
+
+        public SitemapsStep(ISitemapManager sitemapManager)
+        {
+            _sitemapManager = sitemapManager;
+        }
+
+        public async Task ExecuteAsync(RecipeExecutionContext context)
+        {
+            if (!String.Equals(context.Name, "Sitemaps", StringComparison.OrdinalIgnoreCase))
+            {
+                return;
+            }
+
+            var model = context.Step.ToObject<SitemapStepModel>();
+
+            foreach (JObject token in model.Data)
+            {
+                var sitemap = token.ToObject<SitemapType>(Serializer);
+                await _sitemapManager.UpdateSitemapAsync(sitemap);
+            }
+        }
+
+        public class SitemapStepModel
+        {
+            public JArray Data { get; set; }
+        }
+    }
+}

src/OrchardCore.Modules/OrchardCore.Sitemaps/Startup.cs

@@ -8,20 +8,23 @@
 using OrchardCore.ContentManagement;
 using OrchardCore.ContentManagement.Display.ContentDisplay;
 using OrchardCore.Data.Migration;
+using OrchardCore.Deployment;
 using OrchardCore.DisplayManagement;
 using OrchardCore.DisplayManagement.Handlers;
-using OrchardCore.Entities;
 using OrchardCore.Modules;
 using OrchardCore.Mvc.Core.Utilities;
 using OrchardCore.Navigation;
+using OrchardCore.Recipes;
 using OrchardCore.Routing;
 using OrchardCore.Security.Permissions;
 using OrchardCore.Sitemaps.Builders;
 using OrchardCore.Sitemaps.Cache;
 using OrchardCore.Sitemaps.Controllers;
+using OrchardCore.Sitemaps.Deployment;
 using OrchardCore.Sitemaps.Drivers;
 using OrchardCore.Sitemaps.Handlers;
 using OrchardCore.Sitemaps.Models;
+using OrchardCore.Sitemaps.Recipes;
 using OrchardCore.Sitemaps.Routing;
 using OrchardCore.Sitemaps.Services;
 
@@ -87,6 +90,8 @@ public override void ConfigureServices(IServiceCollection services)
             services.AddScoped<ISitemapSourceModifiedDateProvider, CustomPathSitemapSourceModifiedDateProvider>();
             services.AddScoped<IDisplayDriver<SitemapSource>, CustomPathSitemapSourceDriver>();
             services.AddScoped<ISitemapSourceFactory, SitemapSourceFactory<CustomPathSitemapSource>>();
+
+            services.AddRecipeExecutionStep<SitemapsStep>();
         }
 
         public override void Configure(IApplicationBuilder app, IEndpointRouteBuilder routes, IServiceProvider serviceProvider)
@@ -241,4 +246,15 @@ public override void ConfigureServices(IServiceCollection services)
             services.AddSingleton<IBackgroundTask, SitemapCacheBackgroundTask>();
         }
     }
+
+    [RequireFeatures("OrchardCore.Deployment", "OrchardCore.Sitemaps")]
+    public class SitemapsDeployementStartup : StartupBase
+    {
+        public override void ConfigureServices(IServiceCollection services)
+        {
+            services.AddTransient<IDeploymentSource, AllSitemapsDeploymentSource>();
+            services.AddSingleton<IDeploymentStepFactory>(new DeploymentStepFactory<AllSitemapsDeploymentStep>());
+            services.AddScoped<IDisplayDriver<DeploymentStep>, AllSitemapsDeploymentStepDriver>();
+        }
+    }
 }

src/OrchardCore.Modules/OrchardCore.Sitemaps/Views/Items/AllSitemapsDeploymentStep.Edit.cshtml

@@ -0,0 +1,3 @@
+@model dynamic
+
+<h5>@T["All Sitemaps"]</h5>

src/OrchardCore.Modules/OrchardCore.Sitemaps/Views/Items/AllSitemapsDeploymentStep.Summary.cshtml

@@ -0,0 +1,5 @@
+@model dynamic
+
+<h5>@T["All Sitemaps"]</h5>
+
+<span class="hint">@T["Adds all sitemaps to the plan."]</span>

src/OrchardCore.Modules/OrchardCore.Sitemaps/Views/Items/AllSitemapsDeploymentStep.Thumbnail.cshtml

@@ -0,0 +1,4 @@
+@model dynamic
+
+<h4 class="card-title">@T["All Sitemaps"]</h4>
+<p>@T["Exports all sitemaps."]</p>