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. Denna sida förklarar registreringsmodellen, vad som händer vid start när en licens inte täcker ett plugin, och hur du ansluter din egen visare.
Registrering av ett plugin
Varje plugin‑paket exponerar en plugin‑klass. Registrera den en gång, i Application_Start:
Doconut.DoconutHost.Initialize(options =>
{
options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>();
options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});
// En registrerad plugin vars licens saknas kastas här, i Application_Start, och
// webbplatsen svarar sedan på varje begäran med en tom 500. Anledningen finns i Windows‑händelseloggen.AddPlugin<TPlugin>() skapar pluginet och låter det registrera sina bidrag med DoconutOptions. Allt som ett plugin bidrar med är märkt med pluginets required capability, och DoconutHost.Initialize kontrollerar varje registrerat plugin mot licensen innan webbplatsen hanterar sin första begäran.
En saknad plugin‑licens stoppar webbplatsen
När ingen aktiv licens beviljar ett registrerat plugins kapacitet — ingen licens alls, en äldre TRIAL‑fil, eller en betald licens utan den kapaciteten — DoconutHost.Initialize kastar InvalidOperationException från Application_Start:
The Converter plugin is registered via AddPlugin but no active license grants Converter.
Remove the AddPlugin<...>() call or install a license (or trial/demo) that includes Converter.I System.Web ger ett undantag i Application_Start ingen fel‑sida. Varje begäran svarar med en tom 500, IIS‑loggen visar inget användbart, och meddelandet visas endast i Windows‑händelseloggen (Applikationslogg, källa ASP.NET). När en webbplats slutar svara precis efter att en AddPlugin‑rad har lagts till, kontrollera licensfilerna i wwwroot först — se Licensinställning.
Kontraktet
Ett 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 viewers/services
}Inuti Register accepterar byggaren två typer av bidrag:
builder.RegisterViewer(extension, factory)— en visare för en filändelse; fabriken returnerar enIFormatViewer(DICOM‑pluginet registrerar.dcmoch.imapå 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 valfria plugins; Search och Annotation är inbyggda funktioner som styrs på samma sätt. Grundvisaren är inte en kapacitet — den är förutsättningen, exponerad som IsViewerLicensed på licenstjänsten.
Startvalidering håller normalt ett olicensierat plugin ute ur begäran‑pipeline. Visarfabriken tillämpar också två defensiva regler, som är viktiga om rättigheter förändras medan webbplatsen körs:
- Ett plugin som åsidosätter en inbyggd visare (det påstår en filändelse som en inbyggd visare också hanterar): med den licensierade kapaciteten vinner plugin‑visaren; utan den faller Doconut tillbaka på den inbyggda visaren. Användare ser fortfarande sitt dokument; de får bara inte plugin‑beteendet.
- Ett format som endast stöds av plugin (
.dcmoch.ima— DICOM har ingen inbyggd visare): utan kapaciteten misslyckas öppningen:
LicenseException: This document type requires the 'Dicom' plugin license.En aktiv Tillfällig licens beviljar alla kapaciteter. Det är en klassisk överraskning vid driftsättning: samma AddPlugin‑rader som kördes under utvärderingen stoppar webbplatsen när den köpta licensen utelämnar en av dessa kapaciteter. Jämför IsCapabilityGranted(...) med vad du köpte innan du distribuerade. Med ingen licens alls beviljas inget — en saknad licens är inte en Tillfällig licens.
Samma gating når webbläsaren: Viewer.ReferenceScripts() och ReferenceCss() skickar filerna för licensstyrda funktioner (Sök, Annotation) endast när licensen beviljar dem, så sidan erbjuder aldrig en funktion som servern kommer att avvisa.
Funktion- och plugin‑karta
| Funktion | Hur den aktiveras | Kapacitet | Bidrar med |
|---|---|---|---|
| Annotation | Inbyggd i visaren; inkludera annoteringsresurserna | Annotation | Browser‑författande, sessions‑beständighet, inbrända exporteringar |
| Search | Inbyggd i sökbara format‑visare; inkludera sökresurserna | Search | Inbyggt textindex, markeringar, resultatsnavigering |
| Converter | Installera Doconut.NETFramework.Converter och registrera ConverterPlugin | Converter | C#‑konverteringstjänst och en valfri webbwidget |
| DICOM | Installera Doconut.NETFramework.Dicom och registrera DicomPlugin | Dicom | Medicinsk bildvisning för .dcm och .ima |
| Signer | Installera Doconut.NETFramework.Signer och registrera SignerPlugin | Signer | Synliga signaturer och digitala sigill för PDF och Word: C#‑signeringstjänst och en valfri webbwidget |
Annotation och Search använder inte AddPlugin<TPlugin>(). Converter, DICOM och Signer har var sin sida under Plugins med deras konfiguration och användning. I detta paket renderar DICOM sidor, ramar och animationer, men läser inte teknisk metadata — se DICOM‑plugin.
Anpassade visare — din egen format‑hanterare
Du kan ansluta en visare till pipeline utan att skriva ett plugin‑paket, direkt i Application_Start:
Doconut.DoconutHost.Initialize(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. När du inte tillhandahåller någon standardkonfiguration använder fabriken en ImageConfig.
Slutsatser
- Plugins registreras explicit i
DoconutHost.Initialize, och deras kapaciteter valideras där; en saknad rättighet stoppar webbplatsen med en tom500vars orsak finns i Windows‑händelseloggen. - Override‑stil plugins degraderas smidigt; plugin‑endast format misslyckas med en
LicenseException. - En aktiv Tillfällig licens låser upp allt; produktion låser upp det du köpte. Kontrollera med
IDoconutLicenseServiceinnan leverans.
Var den här sidan hjälpsam?