Plugin-system

Utöka visaren med plugins

Doconuts kärna är 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 licensstyrning fungerar vid körning, och hur du ansluter din egen visare.

Registrering av en 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 pluginregistret som hålls i DoconutOptions. Allt som ett plugin bidrar med märks med pluginens krävda kapacitet. AddDoconut() validerar registrerade plugins omedelbart: en saknad licens, gammal TRIAL‑fil, eller betald licens utan kapaciteten får startprocessen att misslyckas med InvalidOperationException. En Temporary/Demo‑registrering behålls över utgången, men dess körningskapaciteter återkallas efter utgångsdatumet.

Kontraktet

text
public interface IDoconutPlugin
{
    string Name { get; }                          // e.g. "Doconut DICOM Viewer"
    LicenseCapability RequiredCapability { get; } // the license gate
    void Register(IDoconutPluginBuilder builder); // contribute viewers/services
}

Inuti Register accepterar byggaren två typer av bidrag:

  • builder.RegisterViewer(".dcm", () => new DicomViewer()) — en visare för en filändelse,
  • builder.RegisterService<TContract>(() => …) — en typad tjänst som andra delar av pipelinen kan slå upp.

Kapaciteter och styrning

Kapaciteter är licensenheterna. Converter och Dicom levereras som valfria 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 i licenstjänsten.

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

  • Plugin åsidosätter en inbyggd visare (ett plugin påstår en filändelse som den inbyggda registret också hanterar): med den licensierade kapaciteten vinner plugin‑visaren; utan den, faller Doconut tyst tillbaka till den inbyggda visaren. Användare ser fortfarande sitt dokument — de får bara inte plugin‑funktionen.
  • Endast plugin‑format (t.ex. .dcm — 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, 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, beviljas inget — en saknad licens är inte en Temporary‑licens.

Samma styrning visas på klientsidan: Viewer.ReferenceScripts() och ReferenceCss() genererar skript-/stilmallar för de licensstyrda funktionerna (sökning, 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
AnnotationInbyggd i visaren; inkludera annoteringsresurserAnnotationWebbläsarredigering, sessionsbestä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 navigering av resultat
ConverterInstallera Doconut.NET8.Converter och registrera ConverterPluginConverterC#‑konverteringstjänst och valfri webbwidget
DICOMInstallera Doconut.NET8.Dicom och registrera DicomPluginDicomVisning av medicinska bilder för .dcm och .ima

Släppta pluginpaket

PluginPaketKapacitetBidrar
ConverterDoconut.NET8.ConverterConverterDokumentkonverteringskapacitet
DICOMDoconut.NET8.DicomDicomVisning av medicinska bilder (.dcm — endast plugin‑format)

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:

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

Anpassade visare har företräde framför allt — inbyggda och plugins lika — och är inte licensstyrda (de är din kod). Fabriken faller tillbaka på 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.
  • Plugins som åsidosätter en inbyggd visare degraderar graciöst; endast plugin‑format misslyckas med ett LicenseException.
  • En aktiv Temporary‑licens låser upp allt; produktion låser upp det du har köpt. Verifiera med IDoconutLicenseService innan du levererar.

Var den här sidan till hjälp?