v14: Add Preview controller (#15481)

* Add Preview controller

* Implement PreviewService

* Add tests for endpoints.

* Add Authorization to previews

* Apply suggestions from code review

Co-authored-by: Elitsa Marinovska <21998037+elit0451@users.noreply.github.com>

---------

Co-authored-by: Elitsa <elm@umbraco.dk>
Co-authored-by: Elitsa Marinovska <21998037+elit0451@users.noreply.github.com>

src/Umbraco.Cms.Api.Management/Controllers/Preview/EndPreviewController.cs

@@ -0,0 +1,23 @@
+using Asp.Versioning;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+using Umbraco.Cms.Core.Services;
+
+namespace Umbraco.Cms.Api.Management.Controllers.Preview;
+
+[ApiVersion("1.0")]
+public class EndPreviewController : PreviewControllerBase
+{
+    private readonly IPreviewService _previewService;
+
+    public EndPreviewController(IPreviewService previewService) => _previewService = previewService;
+
+    [HttpDelete]
+    [MapToApiVersion("1.0")]
+    [ProducesResponseType(StatusCodes.Status200OK)]
+    public IActionResult End()
+    {
+        _previewService.EndPreview();
+        return Ok();
+    }
+}

src/Umbraco.Cms.Api.Management/Controllers/Preview/EnterPreviewController.cs

@@ -0,0 +1,23 @@
+using Asp.Versioning;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+using Umbraco.Cms.Core.Services;
+
+namespace Umbraco.Cms.Api.Management.Controllers.Preview;
+
+[ApiVersion("1.0")]
+public class EnterPreviewController : PreviewControllerBase
+{
+    private readonly IPreviewService _previewService;
+
+    public EnterPreviewController(IPreviewService previewService) => _previewService = previewService;
+
+    [HttpPost]
+    [MapToApiVersion("1.0")]
+    [ProducesResponseType(StatusCodes.Status200OK)]
+    public IActionResult Enter()
+    {
+        _previewService.EnterPreview();
+        return Ok();
+    }
+}

src/Umbraco.Cms.Api.Management/Controllers/Preview/PreviewControllerBase.cs

@@ -0,0 +1,13 @@
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Mvc;
+using Umbraco.Cms.Api.Management.Routing;
+using Umbraco.Cms.Web.Common.Authorization;
+
+namespace Umbraco.Cms.Api.Management.Controllers.Preview;
+
+[ApiController]
+[VersionedApiBackOfficeRoute("preview")]
+[ApiExplorerSettings(GroupName = "Preview")]
+public class PreviewControllerBase : ManagementApiControllerBase
+{
+}

src/Umbraco.Core/DependencyInjection/UmbracoBuilder.cs

@@ -348,6 +348,7 @@ namespace Umbraco.Cms.Core.DependencyInjection
 
             Services.AddSingleton<ConflictingPackageData>();
             Services.AddSingleton<CompiledPackageXmlParser>();
+            Services.AddUnique<IPreviewService, PreviewService>();
 
             // Register a noop IHtmlSanitizer to be replaced
             Services.AddUnique<IHtmlSanitizer, NoopHtmlSanitizer>();

src/Umbraco.Core/Services/IPreviewService.cs

@@ -0,0 +1,14 @@
+namespace Umbraco.Cms.Core.Services;
+
+public interface IPreviewService
+{
+    /// <summary>
+    /// Enters preview mode for a given user that calls this
+    /// </summary>
+    void EnterPreview();
+
+    /// <summary>
+    /// Exits preview mode for a given user that calls this
+    /// </summary>
+    void EndPreview();
+}

src/Umbraco.Core/Services/PreviewService.cs

@@ -0,0 +1,15 @@
+using Umbraco.Cms.Core.Web;
+
+namespace Umbraco.Cms.Core.Services;
+
+public class PreviewService : IPreviewService
+{
+    private readonly ICookieManager _cookieManager;
+
+    public PreviewService(ICookieManager cookieManager) => _cookieManager = cookieManager;
+
+    public void EnterPreview() => _cookieManager.SetCookieValue(Constants.Web.PreviewCookieName, "preview");
+
+
+    public void EndPreview() => _cookieManager.ExpireCookie(Constants.Web.PreviewCookieName);
+}