Sistema de Plugins
Amplía el visor con plugins
El núcleo de Doconut se mantiene ligero; la funcionalidad opcional se entrega como plugins — paquetes NuGet separados que aportan visores o servicios y se activan con su licencia. Esta página explica el modelo de registro, cómo funciona la limitación de licencia en tiempo de ejecución y cómo conectar su propio visor.
Registro de un plugin
Cada paquete de plugin expone una clase de plugin. La registra una vez, al iniciar:
builder.Services.AddDoconut(options =>
{
options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>();
options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});AddPlugin<TPlugin>() instancia el plugin e invoca su callback Register contra el registro de plugins mantenido en DoconutOptions. Todo lo que un plugin aporta está etiquetado con la capacidad requerida del plugin. AddDoconut() valida los plugins registrados inmediatamente: una licencia faltante, un archivo legacy TRIAL, o una licencia paga sin la capacidad hacen que el inicio falle con InvalidOperationException. Un registro Temporal/Demo se conserva después de la expiración, pero sus capacidades en tiempo de ejecución se revocan tras la fecha de expiración.
El contrato
Un plugin implementa una interfaz deliberadamente pequeña:
public interface IDoconutPlugin
{
string Name { get; } // p.ej. "Doconut DICOM Viewer"
LicenseCapability RequiredCapability { get; } // la puerta de licencia
void Register(IDoconutPluginBuilder builder); // contribuir visores/servicios
}Dentro de Register, el constructor acepta dos tipos de contribuciones:
builder.RegisterViewer(extension, factory)— un visor para una extensión de archivo; la fábrica devuelve unIFormatViewer(el plugin DICOM registra.dcmy.imade esta manera),builder.RegisterService<TContract>(() => …)— un servicio tipado que otras partes del pipeline pueden buscar.
Capacidades y limitación
Las capacidades son las unidades de licencia. Converter, Dicom y Signer se entregan como plugins opt‑in; Search y Annotation son funciones incorporadas limitadas de la misma manera. El visor base no es una capacidad — es el prerrequisito, expuesto como IsViewerLicensed en el servicio de licencias.
La validación al iniciar normalmente impide que un plugin sin licencia entre en el pipeline de solicitudes. La fábrica de visores también aplica dos reglas defensivas en tiempo de ejecución, que son relevantes si los derechos cambian después del inicio:
- El plugin sobrescribe un visor incorporado (un plugin reclama una extensión que también maneja el registro incorporado): con la capacidad licenciada, el visor del plugin gana; sin ella, Doconut retrocede silenciosamente al visor incorporado. Los usuarios siguen viendo su documento — simplemente no obtienen la función del plugin.
- Formato solo de plugin (
.dcmy.ima— DICOM no tiene visor incorporado): sin la capacidad la llamada de apertura falla de forma crítica:
LicenseException: This document type requires the 'Dicom' plugin license.Una licencia Temporal activa otorga todas las capacidades (con visualización base limpia y sin marcas de agua). Esta es una fuente clásica de sorpresas al lanzar: registrar los mismos plugins con una licencia comprada que omite una de sus capacidades hace que AddDoconut() falle durante el inicio. Compare IsCapabilityGranted(...) con su plan antes de desplegar. Por otro lado: con ninguna licencia en absoluto, no se otorga nada — una licencia faltante no es una licencia Temporal.
La misma limitación aparece del lado del cliente: Viewer.ReferenceScripts() y ReferenceCss() emiten los paquetes de script/estilo para las funciones limitadas por licencia (búsqueda, anotación, …) solo cuando la licencia las habilita, de modo que la UI del widget se mantenga consistente con lo que el servidor realmente hará.
Mapa de funciones y plugins
La UI del producto usa “plugin” como una etiqueta amplia de función, pero el registro del servidor difiere:
| Función | Cómo se habilita | Capacidad | Contribuye |
|---|---|---|---|
| Anotación | Incorporado en el visor; incluye recursos de anotación | Annotation | Creación en el navegador, persistencia de sesión y exportaciones incrustadas |
| Búsqueda | Incorporado en visores de formatos buscables; incluye recursos de búsqueda y habilita la extracción donde sea necesario | Search | Índice de texto nativo, resaltados y navegación de resultados |
| Convertidor | Instale Doconut.NET8.Converter y registre ConverterPlugin | Converter | Servicio de conversión C# y widget web opcional |
| DICOM | Instale Doconut.NET8.Dicom y registre DicomPlugin | Dicom | Visualización de imágenes médicas para .dcm y .ima |
| Firmante | Instale Doconut.NET8.Signer y registre SignerPlugin | Signer | Firmas visibles y sellos digitales para PDF y Word: servicio de firma C# y un widget web opcional |
La anotación y la búsqueda normal no usan AddPlugin<TPlugin>(); sus paquetes se emiten solo cuando la licencia otorga la capacidad correspondiente. Convertidor, DICOM y Firmante son implementaciones opt‑in IDoconutPlugin.
Paquetes de plugins publicados
| Plugin | Paquete | Capacidad | Contribuye |
|---|---|---|---|
| Convertidor | Doconut.NET8.Converter | Converter | Capacidad de conversión de documentos |
| DICOM | Doconut.NET8.Dicom | Dicom | Visualización de imágenes médicas (.dcm y .ima — formatos solo de plugin) |
| Firmante | Doconut.NET8.Signer | Signer | Firma de PDF y Word |
Cada uno tiene una página dedicada bajo Plugins con su configuración y uso.
Visores personalizados — su propio manejador de formato
Puede conectar un visor al pipeline sin escribir un paquete de plugin, directamente desde Program.cs:
builder.Services.AddDoconut(options =>
{
options.RegisterViewer(
".myext",
() => new MyCustomViewer(), // implementa IFormatViewer
() => new ImageConfig { ImageResolution = 150 }); // configuración predeterminada opcional
});
// El controlador de formato que crea la fábrica. Reemplace estos miembros con su propio renderizado.
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() { }
}Los visores personalizados tienen precedencia sobre todo — tanto los incorporados como los plugins — y no están limitados por licencia (son su código). La fábrica recurre a un ImageConfig cuando no proporciona una configuración predeterminada.
Conclusiones
- Los plugins se registran explícitamente y su
LicenseCapabilityse valida duranteAddDoconut()— la falta o insuficiencia de derechos no temporales falla rápidamente. - Los plugins de estilo sobrescritura se degradan de forma elegante; los formatos solo de plugin fallan con un
LicenseException. - Una licencia Temporal activa desbloquea todo; la producción desbloquea lo que compró. Verifique con
IDoconutLicenseServiceantes de lanzar.
¿Fue útil esta página?