Создание дополнения Optimizely CMS

В Часть первая этой серии я рассказал о том, как начать создавать собственный AddOn для Optimizely CMS 12. Это касается того, что я считаю идеальной структурой решения, передовых методов для JavaScript и стилей, расширения интерфейса меню и аутентификации. Во второй части я расскажу о добавлении дополнительного гаджета интерфейса редактора. Вы можете просмотреть примеры из этой серии в этом Шаблон дополнения Optimizely которые я создавал.

Обратите внимание, что весь контент этой статьи написан мной, однако некоторые элементы текста были обработаны с помощью Chat GPT для улучшения краткости или создания более официального тона.

Ниже приведен пример минимально необходимой настройки для вашего контроллера. Обратите внимание на включение [Authorize] атрибут на контроллере и [HttpGet] Атрибут действия. Они гарантируют, что пользователь аутентифицирован и что к интерфейсу нельзя получить доступ с помощью неожиданного HTTP-глагола. Обратите внимание, как я использую id параметр строки запроса для загрузки определенной версии страницы, выбранной пользователем в интерфейсе редактора CMS, для предоставления пользователю контекстно-специфической информации.

[Authorize(Policy = OptimizelyAddOnConstants.AuthorizationPolicy)]
[IFrameComponent(
    Url = "/optimizely-addon/gadget/index/",
    Title = "Example Gadget",
    Description = "An example gadget for the CMS Editor Interface.",
    Categories = "content",
    PlugInAreas = "/episerver/cms/assets",
    MinHeight = 200,
    MaxHeight = 800,
    ReloadOnContextChange = true)]
public sealed class GadgetController : Controller
{
    private readonly IContentLoader _contentLoader;

    public GadgetController(IContentLoader contentLoader)
    {
        _contentLoader = contentLoader;
    }

    [HttpGet]
    [Route("~/optimizely-addon/gadget/index")]
    public IActionResult Index()
    {
        var model = new GadgetViewModel
        {
            Page = GetPageData(Request),
            ContentId = Request.Query["Id"].ToString()
        };

        return View("~/Views/OptimizelyAddOn/Gadget/Index.cshtml", model);
    }

    private PageData? GetPageData(HttpRequest request)
    {
        var contentReferenceValue = request.Query["Id"].ToString() ?? string.Empty;
        if (string.IsNullOrWhiteSpace(contentReferenceValue))
        {
            return null;
        }

        var contentReference = new ContentReference(contentReferenceValue);
        if (_contentLoader.TryGet(contentReference, out var pageData))
        {
            return pageData;
        }

        return null;
    }
}

В гаджете, который я разработал для Стотт Секьюрития сосредоточен исключительно на визуализации предварительного просмотра заголовков безопасности для текущей выбранной страницы. Я добавил эту функцию, поскольку Stott Security поддерживает расширение политики безопасности контента для любой заданной страницы. Чтобы гарантировать, что пользователь может быть понятен контекст для предварительного просмотра заголовка, я загружаю страницу с помощью того же вспомогательного метода и добавляю его в модель представления для моего гаджета.

Ниже приведен пример module.config file. Обратите внимание на включение политики авторизации в качестве атрибута узла модуля; это должно соответствовать политике, требуемой вашим AddOn. Кроме того, убедитесь, что полное имя сборки, содержащей ваш гаджет, указано в узле assemblies.