Система Плагінів
Розширте переглядач за допомогою плагінів
Ядро Doconut залишається легким; додаткова функціональність постачається у вигляді плагінів — окремих пакетів NuGet, які додають переглядачі або сервіси і активуються вашою ліцензією. На цій сторінці пояснюється модель реєстрації, що відбувається під час запуску, коли ліцензія не охоплює плагін, і як підключити власний переглядач.
Реєстрація плагіна
Кожен пакет плагіна надає один клас плагіна. Зареєструйте його один раз у Application_Start:
Doconut.DoconutHost.Initialize(options =>
{
options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>();
options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});
// Зареєстрований плагін, у якого відсутня ліцензія, викликає виключення тут, у Application_Start, і
// сайт потім відповідає на кожен запит порожнім 500. Причина знаходиться у журналі подій Windows.AddPlugin<TPlugin>() створює плагін і дозволяє йому зареєструвати свої внески за допомогою DoconutOptions. Усе, що додає плагін, позначається необхідною можливістю плагіна, і DoconutHost.Initialize перевіряє кожен зареєстрований плагін щодо ліцензії перед тим, як сайт обробить перший запит.
Відсутня ліцензія на плагін зупиняє сайт
Коли жодна активна ліцензія не надає можливість зареєстрованого плагіна — відсутня ліцензія, застарілий файл TRIAL або платна ліцензія без цієї можливості — DoconutHost.Initialize генерує InvalidOperationException з Application_Start:
The Converter plugin is registered via AddPlugin but no active license grants Converter.
Remove the AddPlugin<...>() call or install a license (or trial/demo) that includes Converter.У System.Web виключення в Application_Start не створює сторінку помилки. Кожен запит отримує порожній 500, журнал IIS не містить корисної інформації, а повідомлення з’являється лише в журналі подій Windows (журнал застосувань, джерело ASP.NET). Якщо сайт перестає відповідати одразу після додавання рядка AddPlugin, спочатку перевірте файли ліцензії у wwwroot — див. Налаштування ліцензії.
Контракт
Плагін реалізує навмисно невеликий інтерфейс:
public interface IDoconutPlugin
{
string Name { get; } // наприклад, "Doconut DICOM Viewer"
LicenseCapability RequiredCapability { get; } // ворота ліцензії
void Register(IDoconutPluginBuilder builder); // додайте переглядачі/служби
}Всередині Register будівельник приймає два типи внесків:
builder.RegisterViewer(extension, factory)— переглядач для розширення файлу; фабрика повертаєIFormatViewer(плагін DICOM реєструє.dcmі.imaтаким способом),builder.RegisterService<TContract>(() => …)— типізований сервіс, який інші частини конвеєра можуть знаходити.
Можливості та обмеження
Можливості — це одиниці ліцензії. Converter, Dicom і Signer постачаються як плагіни за вибором; Search і Annotation — вбудовані функції, обмежені тим же способом. Базовий переглядач не є можливістю — це передумова, представлена як IsViewerLicensed у сервісі ліцензій.
Перевірка під час запуску зазвичай не допускає неліцензовані плагіни до конвеєра запитів. Фабрика переглядачів також застосовує два захисних правила, які важливі, якщо права змінюються під час роботи сайту:
- Плагін, який перевизначає вбудований переглядач (він заявляє розширення, яке також обробляє вбудований переглядач): якщо можливість ліцензована, переглядач плагіна переважає; без неї Doconut повертається до вбудованого переглядача. Користувачі все ще бачать документ, просто не отримують поведінку плагіна.
- Формат, підтримуваний лише плагіном (
.dcmі.ima— у DICOM немає вбудованого переглядача): без можливості відкриття не вдається:
LicenseException: This document type requires the 'Dicom' plugin license.Активна тимчасова ліцензія надає всі можливості. Це класичний сюрприз під час запуску: ті ж рядки AddPlugin, які працювали під час оцінки, зупиняють сайт, коли придбана ліцензія пропускає одну з цих можливостей. Порівняйте IsCapabilityGranted(...) з тим, що ви купили перед розгортанням. При повній відсутності ліцензії нічого не надається — відсутня ліцензія не є тимчасовою ліцензією.
Те саме обмеження поширюється на браузер: Viewer.ReferenceScripts() і ReferenceCss() генерують файли для функцій, обмежених ліцензією (Пошук, Анотація) лише коли ліцензія їх надає, тому сторінка ніколи не пропонує функцію, яку сервер відхилить.
Карта функцій та плагінів
| Функція | Як увімкнути | Можливість | Вносить |
|---|---|---|---|
| Анотація | Вбудовано в переглядач; включає ресурси анотації | Annotation | Авторинг у браузері, збереження сесії, вбудовані експорти |
| Пошук | Вбудовано в переглядачі форматів з підтримкою пошуку; включає ресурси пошуку | Search | Рідний текстовий індекс, підсвічування, навігація результатами |
| Конвертер | Встановіть Doconut.NETFramework.Converter і зареєструйте ConverterPlugin | Converter | C# сервіс конвертації та необов’язковий веб‑віджет |
| DICOM | Встановіть Doconut.NETFramework.Dicom і зареєструйте DicomPlugin | Dicom | Перегляд медичних зображень для .dcm та .ima |
| Підписувач | Встановіть Doconut.NETFramework.Signer і зареєструйте SignerPlugin | Signer | Видимі підписи та цифрові печатки для PDF та Word: C# сервіс підпису та необов’язковий веб‑віджет |
Анотація та Пошук не використовують AddPlugin<TPlugin>(). Конвертер, DICOM і Підписувач мають окрему сторінку в розділі Plugins з їхньою конфігурацією та використанням. У цьому пакеті DICOM рендерить сторінки, кадри та анімації, але не читає технічні метадані — див. DICOM Plugin.
Користувацькі переглядачі — ваш власний обробник формату
Ви можете підключити переглядач до конвеєра без створення пакету плагіна, безпосередньо в Application_Start:
Doconut.DoconutHost.Initialize(options =>
{
options.RegisterViewer(
".myext",
() => new MyCustomViewer(), // реалізує IFormatViewer
() => new ImageConfig { ImageResolution = 150 }); // опціональна типова конфігурація
});
// Обробник формату, який створює factory. Замініть ці члени власним рендерингом.
public sealed class MyCustomViewer : Doconut.Core.Interfaces.IFormatViewer
{
public ViewerType ViewerType => ViewerType.None;
public int TotalPages => 0;
public int DefaultWidth => 0;
public int DefaultHeight => 0;
public bool PreferOcr => false;
public Task LoadAsync(Stream documentStream, BaseConfig config, CancellationToken ct = default)
=> Task.CompletedTask;
public Task<byte[]> GetPageImageAsync(int pageNumber, CancellationToken ct = default)
=> Task.FromResult(Array.Empty<byte>());
public void Dispose() { }
}Користувацькі переглядачі мають пріоритет над усім — як над вбудованими, так і над плагінами — і не обмежуються ліцензією: це ваш код. Якщо ви не надаєте конфігурацію за замовчуванням, фабрика використовує ImageConfig.
Висновки
- Плагіни реєструються явно у
DoconutHost.Initialize, і їхні можливості перевіряються там; відсутність прав зупиняє сайт з порожнім500, причина якого записана в журналі подій Windows. - Плагіни типу Override працюють плавно при відсутності можливості; формати, підтримувані лише плагінами, не відкриваються і повертають
LicenseException. - Активна тимчасова ліцензія розблоковує все; у продакшн‑режимі розблоковується те, що ви придбали. Перевірте за допомогою
IDoconutLicenseServiceперед випуском.
Чи була ця сторінка корисною?