سیستم افزونه‌ها

گسترش نمایشگر با افزونه‌ها

هسته Doconut ساده باقی می‌ماند؛ عملکردهای اختیاری به‌صورت افزونه‌ها — بسته‌های جداگانه NuGet که نمایشگرها یا سرویس‌ها را ارائه می‌دهند و توسط مجوز شما فعال می‌شوند. این صفحه مدل ثبت‌نام، نحوه رفتار محدودیت مجوز در زمان اجرا، و چگونگی افزودن نمایشگر خودتان را توضیح می‌دهد.

این مدل در این نسخه جدید است. کتابخانه .NET Standard قبلی هیچ رجیستری افزونه نداشت: تبدیل در خود نمایشگر انجام می‌شد و مجوزهای افزونه از طریق فراخوانی‌های ثابت Viewer.SetLicensePlugin(...) نصب می‌شدند. هیچ‌کدام در اینجا مکانیزم ثبت‌نام نیستند.

ثبت‌نام یک افزونه

هر بسته افزونه یک کلاس افزونه را افشا می‌کند. شما آن را یک‌بار، در زمان راه‌اندازی، ثبت می‌کنید:

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

AddPlugin<TPlugin>() یک نمونه از افزونه را ایجاد می‌کند و فراخوانی Register آن را در مقابل رجیستری افزونه که بر روی DoconutOptions نگهداری می‌شود، اجرا می‌کند. همهٔ آنچه افزونه ارائه می‌دهد با قابلیت مورد نیاز افزونه برچسب‌گذاری می‌شود. AddDoconut() بلافاصله افزونه‌های ثبت‌شده را اعتبارسنجی می‌کند: یک مجوز گمشده، فایل قدیمی TRIAL، یا مجوز پرداخت‌شده بدون قابلیت، راه‌اندازی را با InvalidOperationException متوقف می‌کند. یک ثبت‌نام موقت/دمویی تا پس از انقضا حفظ می‌شود، اما قابلیت‌های زمان اجرا پس از تاریخ انقضا لغو می‌شوند.

قرارداد

یک افزونه یک رابط کاربری به‌طور عمدی کوچک را پیاده‌سازی می‌کند:

csharp
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 نمایشگر داخلی ندارد): بدون داشتن قابلیت، فراخوانی باز کردن به‌صورت سخت‌گیرانه شکست می‌خورد:
text
LicenseException: This document type requires the 'Dicom' plugin license.

یک مجوز موقت فعال هر قابلیت را اعطا می‌کند (با نمایش پایهٔ پاک و بدون واترمارک). این منبع کلاسیک شگفتی‌های راه‌اندازی است: ثبت همان افزونه‌ها با مجوز خریداری‌شده که یکی از قابلیت‌های آن‌ها را حذف می‌کند، باعث می‌شود AddDoconut() در زمان راه‌اندازی شکست بخورد. قبل از استقرار، IsCapabilityGranted(...) را با برنامهٔ خود مقایسه کنید. طرف دیگر: با بدون هیچ مجوزی، هیچ چیزی اعطا نمی‌شود — یک مجوز گمشده یک مجوز موقت نیست.

همان محدودیت در سمت مشتری نیز ظاهر می‌شود: Viewer.ReferenceScripts() و ReferenceCss() بسته‌های اسکریپت/استایل برای ویژگی‌های محدود شده توسط مجوز (جستجو، حاشیه‌نویسی، …) فقط زمانی که مجوز آن‌ها را فعال کند، تولید می‌کنند، بنابراین رابط کاربری ویجت با آنچه سرور واقعاً انجام می‌دهد سازگار می‌ماند.

نقشه ویژگی‌ها و افزونه‌ها

رابط کاربری محصول از «plugin» به‌عنوان برچسب ویژگی گسترده استفاده می‌کند، اما ثبت‌نام سرور متفاوت است:

ویژگیچگونه فعال می‌شودقابلیتمشارکت می‌کند
حاشیه‌نویسیدرون‌ساخت نمایشگر؛ شامل منابع حاشیه‌نویسیAnnotationنویسندگی مرورگر، حفظ نشست، و خروجی‌های سوزانده‌شده
جستجودرون‌ساخت نمایشگرهای فرمت قابل جستجو؛ شامل منابع جستجو و فعال‌سازی استخراج در صورت نیازSearchفهرست متن بومی، هایلایت‌ها، و ناوبری نتایج
مبدلنصب Doconut.NETStandard.Converter و ثبت ConverterPluginConverterسرویس تبدیل C# و ویجت وب اختیاری
DICOMنصب Doconut.NETStandard.Dicom و ثبت DicomPluginDicomنمایش تصویر پزشکی برای .dcm و .ima
امضا کنندهنصب Doconut.NETStandard.Signer و ثبت SignerPluginSignerامضاهای قابل مشاهده و مهرهای دیجیتال برای PDF و Word: سرویس امضای C# و یک ویجت وب اختیاری

حاشیه‌نویسی و جستجوی معمولی از AddPlugin<TPlugin>() استفاده نمی‌کنند؛ بسته‌های آن‌ها فقط زمانی تولید می‌شوند که مجوز قابلیت مربوطه را اعطا کند. مبدل، DICOM و امضا کننده پیاده‌سازی‌های IDoconutPlugin اختیاری هستند.

بسته‌های افزونه منتشر شده

افزونهبستهقابلیتمشارکت می‌کند
مبدلDoconut.NETStandard.ConverterConverterقابلیت تبدیل سند
DICOMDoconut.NETStandard.DicomDicomنمایش تصویر پزشکی (.dcm و .ima — قالب‌های فقط افزونه‌ای)
امضا کنندهDoconut.NETStandard.SignerSignerامضای PDF و Word

هر کدام صفحهٔ اختصاصی خود را تحت Plugins دارند که شامل پیکربندی و استفادهٔ آن است.

نمایشگرهای سفارشی — پردازشگر قالب خودتان

می‌توانید یک نمایشگر را به خط لوله متصل کنید بدون نوشتن بستهٔ افزونه، مستقیماً از Program.cs:

csharp
builder.Services.AddDoconut(options =>
{
    options.RegisterViewer(
        ".myext",
        () => new MyCustomViewer(),               // پیاده‌سازی IFormatViewer
        () => new ImageConfig { ImageResolution = 150 }); // پیکربندی پیش‌فرض اختیاری
});

// دستگیرهٔ فرمت که کارخانه ایجاد می‌کند. این اعضا را با رندرینگ خودتان جایگزین کنید.
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 باز می‌گردد.

نکات کلیدی

  • افزونه‌ها به‌صورت صریح ثبت می‌شوند و LicenseCapability آن‌ها در طول AddDoconut() اعتبارسنجی می‌شود — عدم وجود یا حق‌الامتیاز غیرموقت ناکافی به‌سرعت شکست می‌خورد.
  • افزونه‌های سبک بازنویسی به‌صورت ملایم کاهش می‌یابند؛ قالب‌های فقط افزونه‌ای با یک LicenseException شکست می‌خورند.
  • یک مجوز موقت فعال همه چیز را باز می‌کند؛ محیط تولید آنچه خریداری کرده‌اید را باز می‌کند. قبل از ارسال، با IDoconutLicenseService تأیید کنید.

آیا این صفحه مفید بود؟