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

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

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

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

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; }                          // e.g. "Doconut DICOM Viewer"
    LicenseCapability RequiredCapability { get; } // the license gate
    void Register(IDoconutPluginBuilder builder); // contribute viewers/services
}

Внутри 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() генерируют пакеты скриптов/стилей для функций, ограниченных лицензией (поиск, аннотации и т.д.) только когда лицензия их активирует, поэтому UI виджета остаётся согласованным с тем, что действительно делает сервер.

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

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

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

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

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

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

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

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

builder.Services.AddDoconut(options =>
{
    options.RegisterViewer(
        ".myext",
        () => new MyCustomViewer(),               // implements IFormatViewer
        () => new ImageConfig { ImageResolution = 150 }); // optional default config
});

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

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

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