Système de plugins

Étendre le visualiseur avec des plugins

Le cœur de Doconut reste léger ; les fonctionnalités optionnelles sont livrées sous forme de plugins — des packages NuGet séparés qui apportent des visualiseurs ou des services et qui sont activés par votre licence. Cette page explique le modèle d’enregistrement, le fonctionnement du contrôle de licence à l’exécution, et comment brancher votre propre visualiseur.

Enregistrement d'un plugin

Chaque package de plugin expose une classe de plugin. Vous l’enregistrez une fois, au démarrage :

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

AddPlugin<TPlugin>() instancie le plugin et invoque son rappel Register contre le registre de plugins détenu sur DoconutOptions. Tout ce qu’un plugin apporte est étiqueté avec la capacité requise du plugin. AddDoconut() valide immédiatement les plugins enregistrés : une licence manquante, un fichier legacy TRIAL, ou une licence payante sans la capacité entraîne l’échec du démarrage avec InvalidOperationException. Un enregistrement Temporary/Demo est conservé au-delà de l’expiration, mais ses capacités d’exécution sont révoquées après la date d’expiration.

Le contrat

Un plugin implémente une interface délibérément petite :

csharp
public interface IDoconutPlugin
{
    string Name { get; }                          // par ex. "Doconut DICOM Viewer"
    LicenseCapability RequiredCapability { get; } // la porte de licence
    void Register(IDoconutPluginBuilder builder); // contribuer aux visualiseurs/services
}

À l’intérieur de Register, le constructeur accepte deux types de contributions :

  • builder.RegisterViewer(extension, factory) — un visualiseur pour une extension de fichier ; la fabrique renvoie un IFormatViewer (le plugin DICOM enregistre .dcm et .ima de cette manière),
  • builder.RegisterService<TContract>(() => …) — un service typé que d’autres parties du pipeline peuvent rechercher.

Capacités et contrôle

Les capacités sont les unités de licence. Converter, Dicom et Signer sont livrés comme plugins optionnels ; Search et Annotation sont des fonctionnalités intégrées contrôlées de la même façon. Le visualiseur de base n’est pas une capacité — c’est le prérequis, exposé comme IsViewerLicensed sur le service de licence.

La validation au démarrage empêche normalement un plugin non licencié d’entrer dans le pipeline de requêtes. La fabrique de visualiseur applique également deux règles d’exécution défensives, qui importent si les droits changent après le démarrage :

  • Le plugin remplace un visualiseur intégré (un plugin revendique une extension que le registre intégré gère également) : avec la capacité licenciée, le visualiseur du plugin l’emporte ; sans elle, Doconut revient silencieusement au visualiseur intégré. Les utilisateurs voient toujours leur document — ils n’obtiennent simplement pas la fonctionnalité du plugin.
  • Format uniquement plugin (.dcm et .ima — DICOM n’a aucun visualiseur intégré) : sans la capacité, l’appel d’ouverture échoue brutalement :
text
LicenseException: This document type requires the 'Dicom' plugin license.

Une licence Temporary active accorde toutes les capacités (avec une visualisation de base propre, sans filigrane). C’est une source classique de surprises lors du lancement : enregistrer les mêmes plugins avec une licence achetée qui omet l’une de leurs capacités fait échouer AddDoconut() au démarrage. Comparez IsCapabilityGranted(...) à votre plan avant le déploiement. L’autre côté : avec aucune licence du tout, rien n’est accordé — une licence manquante n’est pas une licence Temporary.

Le même contrôle apparaît côté client : Viewer.ReferenceScripts() et ReferenceCss() émettent les paquets script/style pour les fonctionnalités contrôlées par licence (recherche, annotation, …) uniquement lorsque la licence les active, de sorte que l’interface du widget reste cohérente avec ce que le serveur fera réellement.

Carte des fonctionnalités et des plugins

L’interface du produit utilise « plugin » comme libellé de fonctionnalité large, mais l’enregistrement côté serveur diffère :

FonctionnalitéComment elle est activéeCapacitéContribue
AnnotationIntégré au visualiseur ; inclut les ressources d’annotationAnnotationCréation dans le navigateur, persistance de session et exportations gravées
RechercheIntégré aux visualiseurs de formats recherchables ; inclut les ressources de recherche et active l’extraction lorsque nécessaireSearchIndex de texte natif, surlignages et navigation des résultats
ConvertisseurInstallez Doconut.NET6.Converter et enregistrez ConverterPluginConverterService de conversion C# et widget web optionnel
DICOMInstallez Doconut.NET6.Dicom et enregistrez DicomPluginDicomVisualisation d’images médicales pour .dcm et .ima
SignatureInstallez Doconut.NET6.Signer et enregistrez SignerPluginSignerSignatures visibles et sceaux numériques pour PDF et Word : service de signature C# et widget web optionnel

Annotation et Recherche normales n’utilisent pas AddPlugin<TPlugin>() ; leurs paquets ne sont émis que lorsque la licence accorde la capacité correspondante. Convertisseur, DICOM et Signature sont des implémentations IDoconutPlugin optionnelles.

Packages de plugins publiés

PluginPackageCapacitéContribue
ConvertisseurInstallez Doconut.NET6.ConverterConverterCapacité de conversion de documents
DICOMInstallez Doconut.NET6.DicomDicomVisualisation d’images médicales (.dcm et .ima — formats uniquement plugin)
SignatureInstallez Doconut.NET6.SignerSignerSignature PDF et Word

Chacun possède une page dédiée sous Plugins avec sa configuration et son utilisation.

Visualiseurs personnalisés — votre propre gestionnaire de format

Vous pouvez brancher un visualiseur dans le pipeline sans écrire de package de plugin, directement depuis Program.cs :

csharp
builder.Services.AddDoconut(options =>
{
    options.RegisterViewer(
        ".myext",
        () => new MyCustomViewer(),               // implémente IFormatViewer
        () => new ImageConfig { ImageResolution = 150 }); // configuration par défaut optionnelle
});

// Le gestionnaire de format que la fabrique crée. Remplacez ces membres par votre propre rendu.
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() { }
}

Les visualiseurs personnalisés ont la priorité sur tout — intégrés et plugins confondus — et ne sont pas soumis à un contrôle de licence (c’est votre code). La fabrique revient à un ImageConfig lorsque vous ne fournissez pas de configuration par défaut.

Points clés

  • Les plugins sont enregistrés explicitement et leur LicenseCapability est validé pendant AddDoconut() — une attribution manquante ou insuffisante non temporaire échoue rapidement.
  • Les plugins de type remplacement se dégradent gracieusement ; les formats uniquement plugin échouent avec un LicenseException.
  • Une licence Temporary active débloque tout ; la production débloque ce que vous avez acheté. Vérifiez avec IDoconutLicenseService avant la mise en production.

Cette page était-elle utile ?