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.
Registrering av en plugin
Varje plugin‑paket exponerar en plugin‑klass. Du registrerar den en gång, vid uppstart:
builder.Services.AddDoconut(options =>
{
options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>();
options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});AddPlugin<TPlugin>() initierar pluginen och anropar dess Register‑callback mot plugin‑registret som hålls på DoconutOptions. Allt som en plugin bidrar med märks med pluginens krävda kapacitet. AddDoconut() validerar registrerade plugins omedelbart: en saknad licens, en äldre TRIAL‑fil, eller en 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 avsiktligt litet gränssnitt:
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(".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 gating
Kapaciteter är licensenheterna. Converter och Dicom 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.
Uppstartsvalidering förhindrar normalt en olicensierad plugin från att komma in i begäranpipen. Visarfabriken tillämpar också två defensiva körningsregler, som är viktiga om rättigheten förändras efter uppstart:
- Plugin ersä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 (t.ex.
.dcm— DICOM har ingen inbyggd visare): utan kapaciteten misslyckas öppningsanropet hårt:
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 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 skript-/stilmallar för de licensstyrda funktionerna (sökning, annotation, …) bara 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:
| Funktion | Hur den aktiveras | Kapacitet | Bidrar med |
|---|---|---|---|
| Annotation | Inbyggd i visaren; inkludera annoteringsresurser | Annotation | Webbläsar‑authoring, sessions‑persistens och inbrända exporteringar |
| Sökning | Inbyggd i sökbara formatvisare; inkludera sökresurser och möjliggör extraktion där det krävs | Search | Inbyggt textindex, markeringar och resultatnavigering |
| Konverterare | Installera Doconut.NET8.Converter och registrera ConverterPlugin | Converter | C#‑konverteringstjänst och valfri webbwidget |
| DICOM | Installera Doconut.NET8.Dicom och registrera DicomPlugin | Dicom | Visning av medicinska bilder för .dcm och .ima |
Annotation och normal sökning använder inte AddPlugin<TPlugin>(); deras paket genereras endast när licensen beviljar motsvarande kapacitet. Konverterare och DICOM är opt‑in‑IDoconutPlugin‑implementationer.
Släppta plugin‑paket
| Plugin | Paket | Kapacitet | Bidrar med |
|---|---|---|---|
| Konverterare | Doconut.NET8.Converter | Converter | Dokumentkonverteringskapacitet |
| DICOM | Doconut.NET8.Dicom | Dicom | Visning av medicinska bilder (.dcm — plugin‑only 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:
builder.Services.AddDoconut(options =>
{
options.RegisterViewer(
".myext",
() => new MyCustomViewer(), // implementerar IFormatViewer
() => new ImageConfig { ImageResolution = 150 }); // valfri standardkonfiguration
});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.
Sammanfattning
- Plugins registreras explicit och deras
LicenseCapabilityvalideras underAddDoconut()— saknad eller otillräcklig icke‑tillfällig rättighet misslyckas snabbt. - Överskrivnings‑stil 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
IDoconutLicenseServiceinnan du levererar.
Var den här sidan hjälpsam?