JSON Content Editor

Lombiq.JsonEditor.Test.UI/Extensions/TestCaseUITestContextExtensions.cs

@@ -15,6 +15,7 @@ public static class TestCaseUITestContextExtensions
     private const string WorldValue = "world";
     private const string TestField = "testField";
     private const string TestValue = "testValue";
+    private const string TestAuthor = "Custom Test Author";
 
     private static readonly By ObjectByXPath = By.XPath($"//div[@class='jsoneditor-readonly' and contains(text(),'object')]");
     private static readonly By ObjectCountByXPath = By.XPath($"//div[@class='jsoneditor-value jsoneditor-object' and contains(text(),'{{2}}')]");
@@ -67,6 +68,17 @@ await context.ClickReliablyOnAsync(
 
         await context.SwitchToModeAsync("Preview");
         context.TestCodeStyleMode();
+
+        // Test that content JSON editing works.
+        await context.GoToContentItemListAsync();
+        await context.SelectFromBootstrapDropdownReliablyAsync(
+            By.CssSelector(".list-group-item:nth-child(3) .dropdown-toggle.actions"),
+            "Edit as JSON");
+        context
+            .Get(By.XPath("//div[contains(@class, 'jsoneditor-field') and contains(., 'Author')]/../..//div[contains(@class, 'jsoneditor-value')]"))
+            .FillInWith(TestAuthor);
+        await context.ClickPublishAsync();
+        context.Exists(By.CssSelector(".ta-badge[data-bs-original-title='Author']"));
     }
 
     private static void CheckValueInTreeMode(this UITestContext context, string arrayValue, bool exists = true)

Lombiq.JsonEditor/Controllers/AdminController.cs

@@ -0,0 +1,105 @@
+using Lombiq.HelpfulLibraries.OrchardCore.Contents;
+using Lombiq.JsonEditor.ViewModels;
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Localization;
+using Newtonsoft.Json;
+using OrchardCore.ContentManagement;
+using OrchardCore.Contents;
+using OrchardCore.DisplayManagement;
+using OrchardCore.DisplayManagement.Layout;
+using OrchardCore.Title.ViewModels;
+using System.Threading.Tasks;
+using YesSql;
+
+namespace Lombiq.JsonEditor.Controllers;
+
+public class AdminController : Controller
+{
+    private readonly IAuthorizationService _authorizationService;
+    private readonly IContentManager _contentManager;
+    private readonly ILayoutAccessor _layoutAccessor;
+    private readonly ISession _session;
+    private readonly IShapeFactory _shapeFactory;
+    private readonly IStringLocalizer<AdminController> T;
+
+    public AdminController(
+        IAuthorizationService authorizationService,
+        IContentManager contentManager,
+        ILayoutAccessor layoutAccessor,
+        ISession session,
+        IShapeFactory shapeFactory,
+        IStringLocalizer<AdminController> stringLocalizer)
+    {
+        _authorizationService = authorizationService;
+        _contentManager = contentManager;
+        _layoutAccessor = layoutAccessor;
+        _session = session;
+        _shapeFactory = shapeFactory;
+        T = stringLocalizer;
+    }
+
+    public async Task<IActionResult> Edit(string contentItemId)
+    {
+        if (string.IsNullOrWhiteSpace(contentItemId) ||
+            await _contentManager.GetAsync(contentItemId, VersionOptions.Latest) is not { } contentItem ||
+            !await CanEditAsync(contentItem))
+        {
+            return NotFound();
+        }
+
+        var titleShape = await _shapeFactory.CreateAsync<TitlePartViewModel>("TitlePart", model =>
+        {
+            model.Title = T["Edit {0} as JSON", contentItem.ContentType];
+            model.ContentItem = contentItem;
+        });
+        await _layoutAccessor.AddShapeToZoneAsync("Title", titleShape);
+
+        return View(new EditContentItemViewModel(contentItem, JsonConvert.SerializeObject(contentItem)));
+    }
+
+    [ValidateAntiForgeryToken]
+    [HttpPost, ActionName(nameof(Edit))]
+    public async Task<IActionResult> EditPost(
+        string contentItemId,
+        string json,
+        string returnUrl,
+        [Bind(Prefix = "submit.Publish")] string submitPublish)
+    {
+        if (string.IsNullOrWhiteSpace(contentItemId) ||
+            string.IsNullOrWhiteSpace(json) ||
+            JsonConvert.DeserializeObject<ContentItem>(json) is not { } contentItem)
+        {
+            return NotFound();
+        }
+
+        if (string.IsNullOrWhiteSpace(contentItem.ContentItemId)) contentItem.ContentItemId = contentItemId;
+        if (!await CanEditAsync(contentItem))
+        {
+            return NotFound();
+        }
+
+        if (await _contentManager.GetAsync(contentItem.ContentItemId, VersionOptions.Latest) is { } existing)
+        {
+            existing.Latest = false;
+            existing.Published = false;
+            _session.Save(existing);
+            contentItem.ContentItemVersionId = null;
+        }
+
+        await _contentManager.PublishAsync(contentItem);
+        _session.Save(contentItem);
+
+        if (!string.IsNullOrEmpty(returnUrl) &&
+            submitPublish != "submit.PublishAndContinue" &&
+            Url.IsLocalUrl(returnUrl))
+        {
+            return Redirect(returnUrl);
+        }
+
+        return RedirectToAction(nameof(Edit), new { contentItemId, returnUrl });
+    }
+
+    private Task<bool> CanEditAsync(ContentItem contentItem) =>
+        _authorizationService.AuthorizeAsync(User, CommonPermissions.EditContent, contentItem);
+}

Lombiq.JsonEditor/Drivers/EditJsonActionsMenuContentDisplayDriver.cs

@@ -0,0 +1,14 @@
+using OrchardCore.ContentManagement;
+using OrchardCore.ContentManagement.Display.ContentDisplay;
+using OrchardCore.ContentManagement.Display.ViewModels;
+using OrchardCore.DisplayManagement.ModelBinding;
+using OrchardCore.DisplayManagement.Views;
+
+namespace Lombiq.JsonEditor.Drivers;
+
+public class EditJsonActionsMenuContentDisplayDriver : ContentDisplayDriver
+{
+    public override IDisplayResult Display(ContentItem model, IUpdateModel updater) =>
+        Initialize<ContentItemViewModel>("Content_EditJsonActions", a => a.ContentItem = model.ContentItem)
+            .Location("ActionsMenu:after");
+}

Lombiq.JsonEditor/Startup.cs

@@ -1,25 +1,45 @@
+using Lombiq.JsonEditor.Constants;
+using Lombiq.JsonEditor.Controllers;
 using Lombiq.JsonEditor.Drivers;
 using Lombiq.JsonEditor.Fields;
 using Lombiq.JsonEditor.Settings;
 using Lombiq.JsonEditor.TagHelpers;
+using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Routing;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Options;
+using OrchardCore.Admin;
 using OrchardCore.ContentManagement;
 using OrchardCore.ContentManagement.Display.ContentDisplay;
 using OrchardCore.ContentTypes.Editors;
 using OrchardCore.Modules;
+using OrchardCore.Mvc.Core.Utilities;
 using OrchardCore.ResourceManagement;
+using System;
 
 namespace Lombiq.JsonEditor;
 
 public class Startup : StartupBase
 {
+    private readonly AdminOptions _adminOptions;
+
+    public Startup(IOptions<AdminOptions> adminOptions) => _adminOptions = adminOptions.Value;
+
     public override void ConfigureServices(IServiceCollection services)
     {
         services.AddTransient<IConfigureOptions<ResourceManagementOptions>, ResourceManagementOptionsConfiguration>();
         services.AddTagHelpers<JsonEditorTagHelper>();
 
         services.AddContentField<JsonField>().UseDisplayDriver<JsonFieldDisplayDriver>();
         services.AddScoped<IContentPartFieldDefinitionDisplayDriver, JsonFieldSettingsDriver>();
+
+        services.AddScoped<IContentDisplayDriver, EditJsonActionsMenuContentDisplayDriver>();
     }
+
+    public override void Configure(IApplicationBuilder app, IEndpointRouteBuilder routes, IServiceProvider serviceProvider) =>
+        routes.MapAreaControllerRoute(
+            name: "EditContentItem",
+            areaName: FeatureIds.Area,
+            pattern: _adminOptions.AdminUrlPrefix + "/Contents/ContentItems/{contentItemId}/Edit/Json",
+            defaults: new { controller = typeof(AdminController).ControllerName(), action = nameof(AdminController.Edit) });
 }

Lombiq.JsonEditor/ViewModels/EditContentItemViewModel.cs

@@ -0,0 +1,14 @@
+using OrchardCore.ContentManagement;
+
+namespace Lombiq.JsonEditor.ViewModels;
+
+public record EditContentItemViewModel(
+    string ContentItemId,
+    string DisplayText,
+    string Json)
+{
+    public EditContentItemViewModel(ContentItem contentItem, string json)
+        : this(contentItem.ContentItemId, contentItem.DisplayText, json)
+    {
+    }
+}

Lombiq.JsonEditor/Views/Admin/Edit.cshtml

@@ -0,0 +1,24 @@
+@model Lombiq.JsonEditor.ViewModels.EditContentItemViewModel
+@{
+    var returnUrl = Context.Request.Query["returnUrl"];
+}
+
+<form method="post">
+    @Html.AntiForgeryToken()
+    <input type="hidden" name="contentItemId" value="@Model.ContentItemId">
+    <input type="hidden" name="returnUrl" value="@returnUrl" />
+
+    <div class="form-group mb-3">
+        <json-editor
+            json="@Model.Json"
+            options="@JsonEditorOptions.GetSample(T)"
+            name="json"></json-editor>
+    </div>
+
+    <shape type="Content_PublishButton" />
+
+    @if (!string.IsNullOrWhiteSpace(returnUrl) && Url.IsLocalUrl(returnUrl))
+    {
+        <a class="btn btn-secondary cancel" role="button" href="@returnUrl">@T["Cancel"]</a>
+    }
+</form>

Lombiq.JsonEditor/Views/Content_EditJsonActions.cshtml

@@ -0,0 +1,13 @@
+@using OrchardCore.ContentManagement
+@using Lombiq.JsonEditor.Controllers
+
+@{
+    var contentItem = (ContentItem)Model.ContentItem;
+}
+
+<a asp-action="@nameof(AdminController.Edit)"
+   asp-controller="@typeof(AdminController).ControllerName()"
+   asp-route-area="@FeatureIds.Area"
+   asp-route-contentItemId="@contentItem.ContentItemId"
+   asp-route-returnUrl="@FullRequestPath"
+   class="dropdown-item btn-sm">@T["Edit as JSON"]</a>