Pages MetaData Editing Mode Support

Sitecore.AspNetCore.SDK.sln

@@ -112,6 +112,10 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "ISSUE_TEMPLATE", "ISSUE_TEM
 		.github\ISSUE_TEMPLATE\Question.yml = .github\ISSUE_TEMPLATE\Question.yml
 	EndProjectSection
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Sitecore.AspNetCore.SDK.Pages", "src\Sitecore.AspNetCore.SDK.Pages\Sitecore.AspNetCore.SDK.Pages.csproj", "{F33DC6F7-83F8-41CE-852C-8279D1266139}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Sitecore.AspNetCore.SDK.Pages.Tests", "tests\Sitecore.AspNetCore.SDK.Pages.Tests\Sitecore.AspNetCore.SDK.Pages.Tests.csproj", "{55601B5C-5D9C-66E5-801D-E5D5EA0E29D6}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -186,6 +190,14 @@ Global
 		{100C07C6-C68D-469F-9F15-139CB48CB7F0}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{100C07C6-C68D-469F-9F15-139CB48CB7F0}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{100C07C6-C68D-469F-9F15-139CB48CB7F0}.Release|Any CPU.Build.0 = Release|Any CPU
+		{F33DC6F7-83F8-41CE-852C-8279D1266139}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{F33DC6F7-83F8-41CE-852C-8279D1266139}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{F33DC6F7-83F8-41CE-852C-8279D1266139}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{F33DC6F7-83F8-41CE-852C-8279D1266139}.Release|Any CPU.Build.0 = Release|Any CPU
+		{55601B5C-5D9C-66E5-801D-E5D5EA0E29D6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{55601B5C-5D9C-66E5-801D-E5D5EA0E29D6}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{55601B5C-5D9C-66E5-801D-E5D5EA0E29D6}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{55601B5C-5D9C-66E5-801D-E5D5EA0E29D6}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -221,6 +233,8 @@ Global
 		{100C07C6-C68D-469F-9F15-139CB48CB7F0} = {BDE3D3B9-8291-4AE9-B8DA-868CEBCBDC4D}
 		{1706E43D-AC19-4FBB-9BFB-18A8B195580A} = {5FE82369-DEF2-4136-B74F-6E86DB91050E}
 		{24CCC156-046B-4600-9DB0-FC3269A18747} = {5FE82369-DEF2-4136-B74F-6E86DB91050E}
+		{F33DC6F7-83F8-41CE-852C-8279D1266139} = {75482B5D-21E2-4DBE-BE78-657ECF0D409F}
+		{55601B5C-5D9C-66E5-801D-E5D5EA0E29D6} = {BDE3D3B9-8291-4AE9-B8DA-868CEBCBDC4D}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {2E4F7126-B772-42CB-8F90-93B221ED0A72}

src/Sitecore.AspNetCore.SDK.LayoutService.Client/Response/Model/DataSource.cs

@@ -0,0 +1,30 @@
+using System.Runtime.Serialization;
+using System.Text.Json.Serialization;
+
+namespace Sitecore.AspNetCore.SDK.LayoutService.Client.Response.Model;
+
+/// <summary>
+/// Class used to define an items datasource information.
+/// </summary>
+public class DataSource
+{
+    /// <summary>
+    /// Gets or sets the Id.
+    /// </summary>
+    public string Id { get; set; } = string.Empty;
+
+    /// <summary>
+    /// Gets or sets the Language.
+    /// </summary>
+    public string Language { get; set; } = string.Empty;
+
+    /// <summary>
+    /// Gets or sets the Revision.
+    /// </summary>
+    public string Revision { get; set; } = string.Empty;
+
+    /// <summary>
+    /// Gets or sets the Version.
+    /// </summary>
+    public int Version { get; set; }
+}

src/Sitecore.AspNetCore.SDK.LayoutService.Client/Response/Model/EditableField.cs

@@ -14,4 +14,22 @@ public class EditableField<TValue>
     [DataMember(Name = "editable")]
     [JsonPropertyName("editable")]
     public string EditableMarkup { get; set; } = string.Empty;
+
+    /// <summary>
+    /// Gets or Sets the id of the Field.
+    /// </summary>
+    [DataMember(Name = "Id")]
+    [JsonPropertyName("Id")]
+    public string Id { get; set; } = string.Empty;
+
+    /// <inheritdoc />
+    public EditableChrome? OpeningChrome { get; set; }
+
+    /// <inheritdoc />
+    public EditableChrome? ClosingChrome { get; set; }
+
+    /// <summary>
+    /// Gets or Sets the MetaSata for the Field.
+    /// </summary>
+    public MetaData? MetaData { get; set; }
 }

src/Sitecore.AspNetCore.SDK.LayoutService.Client/Response/Model/IEditableField.cs

@@ -9,4 +9,14 @@ public interface IEditableField : IField
     /// Gets or sets the HTML markup for this <see cref="IField"/> when editing.
     /// </summary>
     public string EditableMarkup { get; set; }
+
+    /// <summary>
+    /// Gets or sets the EditableChrome used to render the opening chrome for this field.
+    /// </summary>
+    public EditableChrome? OpeningChrome { get; set; }
+
+    /// <summary>
+    /// Gets or sets the EditableChrome used to render the closing chrome for this field.
+    /// </summary>
+    public EditableChrome? ClosingChrome { get; set; }
 }

src/Sitecore.AspNetCore.SDK.LayoutService.Client/Response/Model/MetaData.cs

@@ -0,0 +1,32 @@
+namespace Sitecore.AspNetCore.SDK.LayoutService.Client.Response.Model;
+
+/// <summary>
+/// Class used to define an items metadata information.
+/// </summary>
+public class MetaData
+{
+    /// <summary>
+    /// Gets or sets the title.
+    /// </summary>
+    public string Title { get; set; } = string.Empty;
+
+    /// <summary>
+    ///  Gets or sets the FieldId.
+    /// </summary>
+    public string FieldId { get; set; } = string.Empty;
+
+    /// <summary>
+    ///  Gets or sets the FieldType.
+    /// </summary>
+    public string FieldType { get; set; } = string.Empty;
+
+    /// <summary>
+    ///  Gets or sets the RawValue.
+    /// </summary>
+    public string RawValue { get; set; } = string.Empty;
+
+    /// <summary>
+    ///  Gets or sets the DataSource.
+    /// </summary>
+    public DataSource? DataSource { get; set; }
+}

src/Sitecore.AspNetCore.SDK.LayoutService.Client/Response/Model/WrappedEditableField.cs

@@ -8,7 +8,7 @@ namespace Sitecore.AspNetCore.SDK.LayoutService.Client.Response.Model;
 /// that contains a value that can be edited using wrapped HTML markup.
 /// </summary>
 /// <typeparam name="TValue">The value type.</typeparam>
-public class WrappedEditableField<TValue> : Field<TValue>, IWrappedEditableField
+public class WrappedEditableField<TValue> : EditableField<TValue>, IWrappedEditableField
 {
     /// <inheritdoc />
     [DataMember(Name = "editableFirstPart")]

src/Sitecore.AspNetCore.SDK.Pages/Configuration/PagesMarkerService.cs

@@ -0,0 +1,6 @@
+namespace Sitecore.AspNetCore.SDK.Pages.Configuration;
+
+/// <summary>
+/// Marker service used to identify when Pages services have been registered.
+/// </summary>
+internal class PagesMarkerService;

src/Sitecore.AspNetCore.SDK.Pages/Configuration/PagesOptions.cs

@@ -0,0 +1,37 @@
+namespace Sitecore.AspNetCore.SDK.Pages.Configuration;
+
+/// <summary>
+/// The options to configure the Pages middleware.
+/// </summary>
+public class PagesOptions
+{
+    /// <summary>
+    /// Key used to define the settings section in config.
+    /// </summary>
+    public static readonly string Key = "SitecoreXmcPages";
+
+    /// <summary>
+    /// Gets or sets the config endpoint for Pages MetaData mode.
+    /// </summary>
+    public string? ConfigEndpoint { get; set; } = "/api/editing/config";
+
+    /// <summary>
+    /// Gets or sets the render endpoint for Pages MetaData mode.
+    /// </summary>
+    public string? RenderEndpoint { get; set; } = "/api/editing/render";
+
+    /// <summary>
+    /// Gets or sets the valid editing origin for all editing requests.
+    /// </summary>
+    public string? ValidEditingOrigin { get; set; } = "https://pages.sitecorecloud.io";
+
+    /// <summary>
+    /// Gets or sets the valid origins for the head to run under.
+    /// </summary>
+    public string? ValidOrigins { get; set; } = string.Empty;
+
+    /// <summary>
+    /// Gets or sets the Editing Secret.
+    /// </summary>
+    public string? EditingSecret { get; set; } = string.Empty;
+}

src/Sitecore.AspNetCore.SDK.Pages/Constants.cs

@@ -0,0 +1,30 @@
+namespace Sitecore.AspNetCore.SDK.Pages
+{
+    /// <summary>
+    /// Class used to stored constants referenced throughout the Pages project.
+    /// </summary>
+    public static class Constants
+    {
+        /// <summary>
+        /// Class used to hold the names of different Layout Clients used by the Pages project.
+        /// </summary>
+        public static class LayoutClients
+        {
+            /// <summary>
+            /// Name of the Pages Editing Layout Client.
+            /// </summary>
+            public const string Pages = "pages";
+        }
+
+        /// <summary>
+        /// Class used to hold the names of the different tag helpers defined in the Pages project.
+        /// </summary>
+        public static class SitecoreTagHelpers
+        {
+            /// <summary>
+            /// The HTML tag used to render the Editing Scripts tag helper.
+            /// </summary>
+            public const string EditScriptsHtmlTag = "sc-editingscripts";
+        }
+    }
+}

src/Sitecore.AspNetCore.SDK.Pages/Controllers/PagesSetupController.cs

@@ -0,0 +1,149 @@
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
+using Microsoft.Extensions.Primitives;
+using Sitecore.AspNetCore.SDK.Pages.Configuration;
+using Sitecore.AspNetCore.SDK.Pages.Middleware;
+using Sitecore.AspNetCore.SDK.Pages.Models;
+using Sitecore.AspNetCore.SDK.RenderingEngine.Configuration;
+
+namespace Sitecore.AspNetCore.SDK.Pages.Controllers
+{
+    /// <summary>
+    /// Pages Setup Controller, used to handle the configuration requests that MetaData editing mode uses to validate the editing host can connect successfully.
+    /// </summary>
+    /// <param name="options">The Sitecore Pages configuration options.</param>
+    /// <param name="logger">The <see cref="ILogger"/> to use for logging.</param>
+    /// <param name="renderingEngineOptions">The RenderingEngineOptions, used to retriece a list of all registered renderings for the applications.</param>
+    public class PagesSetupController(IOptions<PagesOptions> options, ILogger<PagesSetupController> logger, IOptions<RenderingEngineOptions> renderingEngineOptions) : ControllerBase
+    {
+        private readonly PagesOptions options = options != null ? options.Value : throw new ArgumentNullException(nameof(options));
+        private readonly ILogger<PagesSetupController> logger = logger ?? throw new ArgumentNullException(nameof(logger));
+        private readonly RenderingEngineOptions renderingEngineOptions = renderingEngineOptions != null ? renderingEngineOptions.Value : throw new ArgumentNullException(nameof(renderingEngineOptions));
+
+        /// <summary>
+        /// The Config endpoint used to inform Pages how this editing host is configured and which components are implemented.
+        /// </summary>
+        /// <returns>PagesConfigResponse object.</returns>
+        [HttpGet]
+        public ActionResult<PagesConfigResponse> Config()
+        {
+            if (IsValidPagesConfigRequest(Request))
+            {
+                logger.LogDebug("Processing valid Pages Config request");
+                SetConfigResponseHeaders(Response);
+                return Ok(BuildConfigResponseBody());
+            }
+
+            return BadRequest();
+        }
+
+        /// <summary>
+        /// The render endpoint used to redirect the Pages application to the correct page.
+        /// </summary>
+        /// <returns>Redirect response.</returns>
+        [HttpGet]
+        public IActionResult Render()
+        {
+            if (IsValidPagesRenderRequest(Request))
+            {
+                logger.LogDebug("Processing valid Pages Render request");
+                PagesRenderArgs args = ParseQueryStringArgs(Request);
+                return Redirect($"{args.Route}?mode={args.Mode}&sc_itemid={args.ItemId}&sc_version={args.Version}&sc_lang={args.Language}&sc_site={args.Site}&sc_layoutKind={args.LayoutKind}&secret={args.EditingSecret}&tenant_id={args.TenantId}&route={args.Route}");
+            }
+
+            return BadRequest();
+        }
+
+        private PagesRenderArgs ParseQueryStringArgs(HttpRequest request)
+        {
+            return new PagesRenderArgs
+            {
+                ItemId = Guid.TryParse(request.Query["sc_itemid"].FirstOrDefault(), out Guid itemId) ? itemId : Guid.Empty,
+                EditingSecret = request.Query["secret"].FirstOrDefault() ?? string.Empty,
+                Language = request.Query["sc_lang"].FirstOrDefault() ?? string.Empty,
+                LayoutKind = request.Query["sc_layoutKind"].FirstOrDefault() ?? string.Empty,
+                Mode = request.Query["mode"].FirstOrDefault() ?? string.Empty,
+                Route = request.Query["route"].FirstOrDefault() ?? string.Empty,
+                Site = request.Query["sc_site"].FirstOrDefault() ?? string.Empty,
+                Version = int.TryParse(request.Query["sc_version"].FirstOrDefault(), out int version) ? version : 0,
+                TenantId = request.Query["tenant_id"].FirstOrDefault() ?? string.Empty,
+            };
+        }
+
+        private bool IsValidPagesRenderRequest(HttpRequest httpRequest)
+        {
+            ArgumentNullException.ThrowIfNull(httpRequest);
+
+            if (!IsValidEditingSecret(httpRequest))
+            {
+                logger.LogError("Invalid Pages Editing Secret Value");
+                return false;
+            }
+
+            return true;
+        }
+
+        private PagesConfigResponse BuildConfigResponseBody()
+        {
+            return new PagesConfigResponse
+            {
+                EditMode = "metadata",
+                Components = renderingEngineOptions.RendererRegistry.Select(x => x.Value.ComponentName).ToList()
+            };
+        }
+
+        private void SetConfigResponseHeaders(HttpResponse httpResponse)
+        {
+            httpResponse.Headers.ContentSecurityPolicy = $"frame-ancestors 'self' {options.ValidOrigins} {options.ValidEditingOrigin}";
+            httpResponse.Headers.AccessControlAllowOrigin = options.ValidEditingOrigin;
+            httpResponse.Headers.AccessControlAllowMethods = "GET, POST, OPTIONS, PUT, PATCH, DELETE";
+            httpResponse.StatusCode = StatusCodes.Status200OK;
+            httpResponse.ContentType = "application/json";
+        }
+
+        private bool IsValidPagesConfigRequest(HttpRequest httpRequest)
+        {
+            ArgumentNullException.ThrowIfNull(httpRequest);
+
+            if (!IsValidEditingSecret(httpRequest))
+            {
+                logger.LogError("Invalid Pages Editing Secret Value");
+                return false;
+            }
+
+            if (!RequestHasValidEditingOrigin(httpRequest))
+            {
+                logger.LogError("Invalid Pages Editing Origin");
+                return false;
+            }
+
+            return true;
+        }
+
+        private bool IsValidEditingSecret(HttpRequest httpRequest)
+        {
+            if (httpRequest.Query.TryGetValue("secret", out StringValues editingSecretValues))
+            {
+                string editingSecret = editingSecretValues.FirstOrDefault() ?? string.Empty;
+                if (editingSecret == options.EditingSecret)
+                {
+                    return true;
+                }
+            }
+
+            return false;
+        }
+
+        private bool RequestHasValidEditingOrigin(HttpRequest httpRequest)
+        {
+            if (httpRequest.Headers.Origin == options.ValidEditingOrigin)
+            {
+                return true;
+            }
+
+            return false;
+        }
+    }
+}