Plugin-system

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 aktiveras av din licens. Den här sidan förklarar registreringsmodellen, hur licensgating fungerar vid körning, och hur du ansluter din egen visare.

Denna modell är ny i den här utgåvan. Det tidigare .NET Standard‑biblioteket hade inget plugin‑register: konvertering levde i själva visaren och plugin‑licenser installerades via statiska Viewer.SetLicensePlugin(...)‑anrop. Ingen av dem är en registreringsmekanism här.

Registrering av ett plugin

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

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

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

Kontraktet

Ett plugin implementerar ett avsiktligt 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‑pluginet registrerar .dcm och .ima på detta sätt),
  • builder.RegisterService<TContract>(() => …) — en typad tjänst som andra delar av pipelinen 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. Basvisaren är inte en kapacitet — den är förutsättningen, exponerad som IsViewerLicensed på licenstjänsten.

Startvalidering förhindrar normalt ett olicensierat plugin från att komma in i begäran‑pipelinen. Visarfabriken tillämpar också två defensiva körningsregler, som är viktiga om rättigheter ändras efter start:

  • Plugin åsidosätter en inbyggd visare (ett plugin gör anspråk på en filändelse som det inbyggda registret också hanterar): med den licensierade kapaciteten vinner plugin‑visaren; utan den faller Doconut tyst tillbaka till den inbyggda visaren. Användarna 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 ger alla kapaciteter (med ren, utan vattenstämpel 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 start. Jämför IsCapabilityGranted(...) med din plan innan du distribuerar. Det motsatta: med ingen licens alls, ges 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

Produktens UI använder "plugin" som en bred funktionsetikett, men serverregistreringen skiljer sig:

FunktionHur den aktiverasKapacitetBidrar med
AnnotationInbyggd i visaren; inkludera annoteringsresurserAnnotationWebbläsar‑skapande, sessions‑beständighet och inbrända exporteringar
SearchInbyggd i sökbara formatvisare; inkludera sökresurser och möjliggör extraktion där det krävsSearchInbyggt textindex, markeringar och resultatsökning
ConverterInstallera Doconut.NETStandard.Converter och registrera ConverterPluginConverterC#‑konverteringstjänst och valfri webbwidget
DICOMInstallera Doconut.NETStandard.Dicom och registrera DicomPluginDicomMedicinsk bildvisning för .dcm och .ima
SignerInstallera Doconut.NETStandard.Signer och registrera SignerPluginSignerSynliga signaturer och digitala sigill för PDF och Word: C#‑signeringstjänst och en valfri webbwidget

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

Uppsläppta plugin‑paket

PluginPaketKapacitetBidrar med
ConverterDoconut.NETStandard.ConverterConverterDokumentkonverteringskapacitet
DICOMDoconut.NETStandard.DicomDicomMedicinsk bildvisning (.dcm och .ima — endast plugin‑format)
SignerDoconut.NETStandard.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 pipelinen 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 faller tillbaka till en ImageConfig när du inte tillhandahåller en standardkonfiguration.

Viktiga punkter

  • Plugins registreras explicit och deras LicenseCapability valideras under AddDoconut() — saknad eller otillräcklig icke‑tillfällig rättighet misslyckas snabbt.
  • Override‑style plugins degraderas smidigt; endast plugin‑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 du levererar.

Var den här sidan hjälpsam?