Plugin‑System

Erweitern Sie den Viewer mit Plugins

Der Kern von Doconut bleibt schlank; optionale Funktionalität wird als Plugins bereitgestellt — separate NuGet‑Pakete, die Viewer oder Services beitragen und durch Ihre Lizenz aktiviert werden. Diese Seite erklärt das Registrierungsmodell, wie die Lizenzgating zur Laufzeit funktioniert und wie Sie Ihren eigenen Viewer einbinden.

Registrierung eines Plugins

Jedes Plugin‑Paket stellt eine Plugin‑Klasse bereit. Sie registrieren sie einmalig beim Start:

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

AddPlugin<TPlugin>() instanziiert das Plugin und ruft dessen Register‑Callback im Plugin‑Register auf, das auf DoconutOptions gehalten wird. Alles, was ein Plugin beiträgt, ist mit der erforderlichen Fähigkeit des Plugins gekennzeichnet. AddDoconut() validiert registrierte Plugins sofort: Eine fehlende Lizenz, eine veraltete TRIAL‑Datei oder eine kostenpflichtige Lizenz ohne die Fähigkeit führen beim Start zu einem Fehler mit InvalidOperationException. Eine Temporary/Demo‑Registrierung bleibt über das Ablaufdatum erhalten, aber ihre Laufzeit‑Fähigkeiten werden nach dem Ablaufdatum widerrufen.

Der Vertrag

Ein Plugin implementiert eine bewusst kleine Schnittstelle:

csharp
public interface IDoconutPlugin
{
    string Name { get; }                          // z. B. "Doconut DICOM Viewer"
    LicenseCapability RequiredCapability { get; } // das Lizenztor
    void Register(IDoconutPluginBuilder builder); // Viewer/Services beitragen
}

Innerhalb von Register akzeptiert der Builder zwei Arten von Beiträgen:

  • builder.RegisterViewer(".dcm", () => new DicomViewer()) — ein Viewer für eine Dateierweiterung,
  • builder.RegisterService<TContract>(() => …) — ein typisierter Service, den andere Teile der Pipeline nachschlagen können.

Fähigkeiten und Steuerung

Fähigkeiten sind die Lizenzeinheiten. Converter und Dicom werden als optional aktivierbare Plugins bereitgestellt; Search und Annotation sind eingebaute Funktionen, die auf dieselbe Weise gesteuert werden. Der Basis‑Viewer ist keine Fähigkeit — er ist die Voraussetzung, die als IsViewerLicensed im Lizenz‑Service bereitgestellt wird.

Die Start‑Validierung verhindert normalerweise, dass ein nicht lizenziertes Plugin in die Anforderungspipeline gelangt. Die Viewer‑Factory wendet außerdem zwei defensive Laufzeitregeln an, die wichtig sind, wenn sich die Berechtigung nach dem Start ändert:

  • Plugin überschreibt einen eingebauten Viewer (ein Plugin beansprucht eine Erweiterung, die das eingebaute Register ebenfalls behandelt): Ist die Fähigkeit lizenziert, gewinnt der Plugin‑Viewer; ohne sie fällt Doconut stillschweigend auf den eingebauten Viewer zurück. Benutzer sehen ihr Dokument weiterhin — sie erhalten lediglich nicht die Plugin‑Funktion.
  • Nur‑Plugin‑Format (z. B. .dcm — DICOM hat keinen eingebauten Viewer): Ohne die Fähigkeit schlägt der Öffnungsaufruf hart fehl:
text
LicenseException: This document type requires the 'Dicom' plugin license.

Eine aktive Temporary‑Lizenz gewährt jede Fähigkeit (mit sauberer, nicht wasserzeichen‑versehener Basisansicht). Das ist eine klassische Quelle für Überraschungen beim Go‑Live: Das Registrieren derselben Plugins mit einer gekauften Lizenz, die eine ihrer Fähigkeiten weglässt, lässt AddDoconut() beim Start fehlschlagen. Vergleichen Sie IsCapabilityGranted(...) mit Ihrem Plan, bevor Sie bereitstellen. Das Gegenstück: ohne jegliche Lizenz wird nichts gewährt — eine fehlende Lizenz ist keine Temporary‑Lizenz.

Die gleiche Steuerung erscheint clientseitig: Viewer.ReferenceScripts() und ReferenceCss() erzeugen die Skript‑/Style‑Bundles für die lizenzgesteuerten Funktionen (Suche, Annotation, …) nur wenn die Lizenz sie aktiviert, sodass die UI des Widgets mit dem übereinstimmt, was der Server tatsächlich tut.

Funktions‑ und Plugin‑Übersicht

Die Produkt‑UI verwendet „Plugin“ als breiten Funktionsbegriff, aber die Server‑Registrierung unterscheidet sich:

FunktionWie es aktiviert wirdFähigkeitBeiträgt
AnnotationIm Viewer integriert; Annotation‑Ressourcen einbeziehenAnnotationBrowser‑Autorierung, Sitzungs‑Persistenz und eingebettete Exporte
SucheIn durchsuchbaren Format‑Viewern integriert; Such‑Ressourcen einbeziehen und Extraktion dort aktivieren, wo erforderlichSearchNativer Text‑Index, Hervorhebungen und Ergebnisnavigation
KonverterInstallieren Sie Doconut.NET8.Converter und registrieren Sie ConverterPluginConverterC#‑Konvertierungsservice und optionales Web‑Widget
DICOMInstallieren Sie Doconut.NET8.Dicom und registrieren Sie DicomPluginDicomBetrachtung medizinischer Bilder für .dcm und .ima

Annotation und die normale Suche verwenden nicht AddPlugin<TPlugin>(); ihre Bundles werden nur erzeugt, wenn die Lizenz die entsprechende Fähigkeit gewährt. Konverter und DICOM sind optionale IDoconutPlugin‑Implementierungen.

Veröffentliche Plugin‑Pakete

PluginPaketFähigkeitBeiträgt
KonverterDoconut.NET8.ConverterConverterFähigkeit zur Dokumentkonvertierung
DICOMDoconut.NET8.DicomDicomBetrachtung medizinischer Bilder (.dcm — Nur‑Plugin‑Format)

Jedes hat eine eigene Seite unter Plugins mit seiner Konfiguration und Nutzung.

Benutzerdefinierte Viewer — Ihr eigener Format‑Handler

Sie können einen Viewer in die Pipeline einbinden, ohne ein Plugin‑Paket zu schreiben, direkt von Program.cs:

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

Benutzerdefinierte Viewer haben Vorrang vor allen — eingebauten und Plugins gleichermaßen — und sind nicht lizenzgesteuert (sie sind Ihr Code). Die Factory greift auf ein ImageConfig zurück, wenn Sie keine Standardkonfiguration bereitstellen.

Wichtige Erkenntnisse

  • Plugins werden explizit registriert und ihr LicenseCapability wird während AddDoconut() validiert — fehlende oder unzureichende nicht‑temporäre Berechtigung schlägt sofort fehl.
  • Override‑Plugins degradieren elegant; Nur‑Plugin‑Formate schlagen mit einem LicenseException fehl.
  • Eine aktive Temporary‑Lizenz schaltet alles frei; die Produktionslizenz schaltet das frei, was Sie gekauft haben. Überprüfen Sie mit IDoconutLicenseService vor dem Versand.

War diese Seite hilfreich?