Система плагинов

Ядро Doconut остаётся лёгким; дополнительный функционал поставляется в виде плагинов — отдельных пакетов NuGet, которые предоставляют просмотрщики или сервисы и активируются вашей лицензией. На этой странице объясняется модель регистрации, как работает ограничение лицензией во время выполнения и как подключить собственный просмотрщик.

Эта модель нова в данном выпуске. Предыдущая библиотека .NET Standard не имела реестра плагинов: конверсия была встроена в сам просмотрщик, а лицензии плагинов устанавливали через статические вызовы Viewer.SetLicensePlugin(...). Ни то, ни другое не является механизмом регистрации здесь.

Регистрация плагина

Каждый пакет плагина предоставляет один класс плагина. Вы регистрируете его один раз при запуске:

builder.Services.AddDoconut(options =>
{
    options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>();
    options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});

AddPlugin<TPlugin>() создает экземпляр плагина и вызывает его обратный вызов Register в реестре плагинов, хранящемся в DoconutOptions. Всё, что предоставляет плагин, помечается требуемой возможностью плагина. AddDoconut() сразу проверяет зарегистрированные плагины: отсутствие лицензии, устаревший файл TRIAL или платная лицензия без необходимой возможности приводят к сбою запуска с InvalidOperationException. Регистрация Temporary/Demo сохраняется после истечения срока, но её возможности во время выполнения отзываются после даты истечения.

Контракт

Плагин реализует преднамеренно небольшой интерфейс:

public interface IDoconutPlugin
{
    string Name { get; }                          // например "Doconut DICOM Viewer"
    LicenseCapability RequiredCapability { get; } // лицензионный шлюз
    void Register(IDoconutPluginBuilder builder); // внести вклад в просмотрщики/службы
}

Внутри Register построитель принимает два типа вкладов:

• builder.RegisterViewer(".dcm", () => new DicomViewer()) — просмотрщик для расширения файла,
• builder.RegisterService<TContract>(() => …) — типизированный сервис, который могут искать другие части конвейера.

Возможности и ограничения

Возможности представляют собой единицы лицензии. Converter и Dicom поставляются как плагины по запросу; Search и Annotation являются встроенными функциями, ограниченными тем же способом. Базовый просмотрщик не является возможностью — это предпосылка, представляемая как IsViewerLicensed в сервисе лицензий.

Проверка при запуске обычно не позволяет нелицензированному плагину попасть в конвейер запросов. Фабрика просмотрщика также применяет два защитных правила во время выполнения, которые важны, если права меняются после запуска:

• Плагин переопределяет встроенный просмотрщик (плагин заявляет расширение, которое также обрабатывается встроенным реестром): при наличии лицензии на возможность плагин‑просмотрщик выигрывает; без неё Doconut тихо переходит к встроенному просмотрщику. Пользователи всё равно видят документ — просто они не получают функцию плагина.
• Формат только для плагина (например, .dcm — у DICOM нет встроенного просмотрщика): без возможности вызов открытия завершается с ошибкой:

LicenseException: This document type requires the 'Dicom' plugin license.

Активная временная (Temporary) лицензия предоставляет все возможности (с чистым, без водяных знаков базовым просмотром). Это классический источник сюрпризов при запуске: регистрация тех же плагинов с приобретённой лицензией, в которой отсутствует одна из их возможностей, приводит к сбою AddDoconut() во время старта. Сравните IsCapabilityGranted(...) с вашим планом перед развертыванием. С другой стороны: при полном отсутствии лицензии ничего не предоставляется — отсутствие лицензии не является временной лицензией.

То же ограничение проявляется на клиенте: Viewer.ReferenceScripts() и ReferenceCss() генерируют пакеты скриптов/стилей для функций, ограниченных лицензией (поиск, аннотация, …) только когда лицензия их активирует, поэтому интерфейс виджета остаётся согласованным с тем, что действительно делает сервер.

Карта функций и плагинов

В пользовательском интерфейсе продукта слово «плагин» используется как широкая метка функции, но регистрация на сервере отличается:

Аннотация и обычный поиск не используют AddPlugin<TPlugin>(); их пакеты генерируются только когда лицензия предоставляет соответствующую возможность. Конвертер и DICOM являются выпущенными по запросу реализациями IDoconutPlugin для этого набора документации.

Утверждённые артефакты .NET Standard содержат Doconut.NETStandard.Converter и Doconut.NETStandard.Dicom той же версии, что и основной пакет.

Выпущенные пакеты плагинов

У каждого есть отдельная страница в разделе Plugins с конфигурацией и использованием.

Пользовательские просмотрщики — ваш собственный обработчик формата

Вы можете подключить просмотрщик к конвейеру без написания пакета плагина, напрямую из Program.cs:

builder.Services.AddDoconut(options =>
{
    options.RegisterViewer(
        ".myext",
        () => new MyCustomViewer(),               // реализует IFormatViewer
        () => new ImageConfig { ImageResolution = 150 }); // необязательная конфигурация по умолчанию
});

Пользовательские просмотрщики имеют приоритет над всем — как над встроенными, так и над плагинами — и не ограничены лицензией (это ваш код). Фабрика переходит к ImageConfig, если вы не предоставляете конфигурацию по умолчанию.

Ключевые выводы

• Плагины регистрируются явно, и их LicenseCapability проверяется во время AddDoconut() — отсутствие или недостаточное не временное право приводит к быстрому сбою.
• Плагины типа переопределения деградируют плавно; форматы только для плагина завершаются с ошибкой LicenseException.
• Активная временная (Temporary) лицензия разблокирует всё; продакшн‑лицензия разблокирует то, что вы приобрели. Проверьте с помощью IDoconutLicenseService перед выпуском.