Pluginsystem

Utöka visaren med plugins

Doconuts kärna förblir slank; valfri funktionalitet levereras som plugins — separata NuGet‑paket som bidrar med visare eller tjänster och slås på av din licens. Den här sidan förklarar registreringsmodellen, hur licensgating fungerar vid körning, och hur du ansluter din egen visare.

Registrera en plugin

Varje plugin‑paket exponerar en plugin‑klass. Du registrerar den en gång, vid uppstart:

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

AddPlugin<TPlugin>() instansierar pluginen och anropar dess Register‑callback mot plugin‑registret som hålls på DoconutOptions. Allt som en plugin bidrar med märks med pluginens required capability. AddDoconut() validerar registrerade plugins omedelbart: en saknad licens, gammal TRIAL‑fil, eller betald licens utan kapaciteten får uppstarten att misslyckas med InvalidOperationException. En Temporary/Demo‑registrering behålls över utgången, men dess körningskapaciteter återkallas efter utgångsdatumet.

Kontraktet

En plugin implementerar ett medvetet litet gränssnitt:

csharp
public interface IDoconutPlugin
{
    string Name { get; }                          // t.ex. "Doconut DICOM Viewer"
    LicenseCapability RequiredCapability { get; } // licensporten
    void Register(IDoconutPluginBuilder builder); // bidra med visare/tjänster
}

Inuti Register accepterar byggaren två typer av bidrag:

  • builder.RegisterViewer(extension, factory) — en visare för en filändelse; fabriken returnerar en IFormatViewer (DICOM‑pluginen registrerar .dcm och .ima på detta sätt),
  • builder.RegisterService<TContract>(() => …) — en typad tjänst som andra delar av pipeline kan slå upp.

Kapaciteter och gating

Kapaciteter är licensenheterna. Converter, Dicom och Signer levereras som opt‑in‑plugins; Search och Annotation är inbyggda funktioner som styrs på samma sätt. Bas‑visaren är inte en kapacitet — den är förutsättningen, exponerad som IsViewerLicensed på licenstjänsten.

Uppstartsvalidering förhindrar normalt en olicensierad plugin från att komma in i begäran‑pipeline. Visarfabriken tillämpar också två defensiva körningsregler, som är viktiga om rättigheter ändras efter uppstart:

  • Plugin åsidosätter en inbyggd visare (en plugin påstår en filändelse som den inbyggda registret också hanterar): med den licensierade kapaciteten vinner plugin‑visaren; utan den, Doconut återgår tyst till den inbyggda visaren. Användare ser fortfarande sitt dokument — de får bara inte plugin‑funktionen.
  • Endast plugin‑format (.dcm och .ima — DICOM har ingen inbyggd visare): utan kapaciteten misslyckas öppningsanropet hårt:
text
LicenseException: This document type requires the 'Dicom' plugin license.

En aktiv Temporary‑licens beviljar alla kapaciteter (med ren, o‑vattenmärkt basvisning). Detta är en klassisk källa till överraskningar vid driftsättning: att registrera samma plugins med en köpt licens som utelämnar en av deras kapaciteter får AddDoconut() att misslyckas under uppstart. Jämför IsCapabilityGranted(...) med din plan innan du distribuerar. Det motsatta: med ingen licens alls, beviljas inget — en saknad licens är inte en Temporary‑licens.

Samma gating visas på klientsidan: Viewer.ReferenceScripts() och ReferenceCss() genererar script-/style‑paketen för de licensstyrda funktionerna (sök, annotation, …) endast när licensen aktiverar dem, så widgetens UI förblir konsekvent med vad servern faktiskt gör.

Funktion- och plugin‑karta

Produkt‑UI använder “plugin” som en bred funktionsetikett, men serverregistreringen skiljer sig:

FunktionHur den aktiverasKapacitetBidrar med
AnnotationInbyggd i visaren; inkluderar annoteringsresurserAnnotationWebbläsar‑authoring, sessions‑persistens och inbrända exporteringar
SökInbyggd i sökbara format‑visare; inkluderar sökresurser och möjliggör extraktion där det krävsSearchInbyggt textindex, markeringar och resultatnavigering
KonverterareInstallera Doconut.NET6.Converter och registrera ConverterPluginConverterC#‑konverteringstjänst och valfri webbwidget
DICOMInstallera Doconut.NET6.Dicom och registrera DicomPluginDicomVisning av medicinska bilder för .dcm och .ima
SignerareInstallera Doconut.NET6.Signer och registrera SignerPluginSignerSynliga signaturer och digitala sigill för PDF och Word: C#‑signeringstjänst och en valfri webbwidget

Annotation och vanlig Sök använder inte AddPlugin<TPlugin>(); deras paket genereras endast när licensen beviljar motsvarande kapacitet. Konverterare, DICOM och Signer är opt‑in IDoconutPlugin‑implementationer.

Utgivna plugin‑paket

PluginPaketKapacitetBidrar med
KonverterareInstallera Doconut.NET6.ConverterConverterDokumentkonverteringskapacitet
DICOMInstallera Doconut.NET6.DicomDicomVisning av medicinska bilder (.dcm och .ima — plugin‑only‑format)
SignerareInstallera Doconut.NET6.SignerSignerPDF‑ och Word‑signering

Var och en har en dedikerad sida under Plugins med sin konfiguration och användning.

Anpassade visare — din egen format‑hanterare

Du kan ansluta en visare till pipeline utan att skriva ett plugin‑paket, direkt från Program.cs:

csharp
builder.Services.AddDoconut(options =>
{
    options.RegisterViewer(
        ".myext",
        () => new MyCustomViewer(),               // implementerar IFormatViewer
        () => new ImageConfig { ImageResolution = 150 }); // valfri standardkonfiguration
});

// Format‑hanteraren som fabriken skapar. Ersätt dessa medlemmar med din egen rendering.
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() { }
}

Anpassade visare har företräde framför allt — både inbyggda och plugins — och är inte licensstyrda (de är din kod). Fabriken återgår till en ImageConfig när du inte tillhandahåller en standardkonfiguration.

Slutsatser

  • Plugins registreras explicit och deras LicenseCapability valideras under AddDoconut() — saknad eller otillräcklig icke‑tillfällig rättighet misslyckas snabbt.
  • Override‑stil plugins degraderas smidigt; plugin‑endast format misslyckas med en LicenseException.
  • En aktiv Temporary‑licens låser upp allt; produktion låser upp det du köpt. Verifiera med IDoconutLicenseService innan leverans.

Var den här sidan hjälpsam?