Jak funguje Viewer

Životní cyklus požadavků na dokument

Doconut vykresluje dokumenty jako stránkované obrázky, poskytované HTTP handlerem, který registruje váš Web.config. Porozumění životnímu cyklu — otevření, token, požadavky na stránky, zavření — vysvětluje téměř veškeré chování, které pozorujete, včetně chybových zpráv.

Pohyblivé součásti

  • Viewer — veřejná služba, kterou získáte z DoconutHost.Services. Otevírá dokumenty a vrací tokeny relace.
  • Dokumentová relace — objekt na straně serveru, který drží načtený dokument, uchováván v paměti pod svým tokenem.
  • DocImage.axd — Doconut.DocImageHandler deklarovaný v Web.config. Odpovídá na každý požadavek, který widget prohlížeče provádí (stránky, miniatury, vyhledávání, anotace, …), vždy identifikovaný tokenem.
  • /doconut-res/* — Doconut.DoconutResourceModule, který poskytuje vlastní skripty, styly a ikony widgetu.

Viewer je bezstavový — záměrně

Viewer neudržuje žádný stav dokumentu na úrovni požadavku a neimplementuje IDisposable. Relace existují nezávisle na něm a jsou vyčištěny vypršením platnosti nebo explicitním CloseDocument(token). System.Web nemá injekci přes konstruktor, takže jej získáte tam, kde jej potřebujete — typicky v akci kontroleru:

csharp
// POST /ViewerApi/Open?fileName=Sample.pdf
[HttpPost]
public async Task<ActionResult> Open(string fileName)
{
    var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();
    var path   = Server.MapPath("~/files/" + Path.GetFileName(fileName));

    var token = await viewer.OpenDocumentAsync(path);
    return Content(token, "text/plain");
}

Co se děje uvnitř OpenDocumentAsync

  1. Licenční brána. Odmítnutá licence (poškozená, na černé listině nebo sestavení mimo aktualizační okno licence) okamžitě vyhodí LicenseException, s důvodem jako zprávou. Otevření se nikdy tiše nevrátí na nižší úroveň pro neplatnou licenci; chybějící licence pouze vodoznakuje.
  2. Vytvoření relace. Továrna vieweru vybere formátový viewer podle přípony souboru a načte dokument (viz Renderovací pipeline). Relace je uložena v paměti pod novým náhodným tokenem s klouzavým vypršením DocOptions.TimeOut minut (výchozí 60). Každý požadavek na stránku resetuje časovač.
  3. Udílení přístupu. S UnsafeMode = false (výchozí) je token svázán s ASP.NET relací požadavku, který jej otevřel: do této relace je zapsán záznam secure-{token}. Otevření musí tedy proběhnout v požadavku se stavem relace — viz Relace a zabezpečení.
  4. Token je vrácen. Je to jediný identifikátor, který prohlížeč potřebuje pro vše, co následuje.

Asynchronní přetížení přijímají cestu k souboru, cestu k souboru plus konfiguraci pro formát (PdfConfig, WordConfig, …), nebo Stream plus FileInfo, jehož přípona určuje formát. Pro kód-behind Web Forms, který nepoužívá asynchronní stránky, OpenDocument nabízí stejné tři vstupy synchronně (cestu, stream s názvem souboru nebo pole bajtů s názvem souboru).

Jak widget získává stránky

Widget volá DocImage.axd s tokenem v řetězci dotazu. To, co handler udělá, závisí na požadavku:

DotazÚčel
?token=…&page=NVykreslený obrázek stránky (PNG)
?token=…&page=N&thumb=1Miniatura
?token=…&zoom=…Zvětšené vykreslení stránky
?token=…&search=termFull-textové vyhledávání (licencí řízené)
?token=…&bookmarksOsnova dokumentu a záložky
?token=…&copy / &showlinks / &fileFormatKopírování textu, hypertextové odkazy a informace o formátu
?token=…&metaTechnická metadata DICOM — nejsou k dispozici v tomto balíčku (odpovídá 404)
?token=…&action=rotate/flip/closeAkce stránky a explicitní zavření (POST)
?token=…&AnnSave=… / &AnnLoadUkládání a načítání anotací

Každý požadavek je nejprve zkontrolován:

  • Žádný token → 404, nebo banner verze, když ShowDoconutInfo = true.
  • Token nepřidělen této ASP.NET relaci → chybový obrázek s textem You Are Not Authorized To View This Page.
  • Neznámý nebo vypršený token → chybový obrázek s textem Document session not found. Please re-open document.

Chybové obrázky jsou běžné PNG soubory odeslané se stavem 200, takže je widget může zobrazit tam, kde by byla stránka. Monitorovací kontrola, která sleduje jen stavový kód, je bude hlásit jako servírované stránky; skutečná stránka má desítky až stovky kilobajtů, chybový obrázek asi 2 KB.

Uzavření dokumentu

csharp
viewer.CloseDocument(token);

CloseDocument odstraňuje relaci (okamžitě uvolňuje dokumentový engine a jeho paměť), odstraňuje záznam secure-{token} z aktuální ASP.NET relace požadavku a ruší token. Je to volitelné — klouzavé vypršení provádí stejný úklid — ale pro velké dokumenty uvolňuje paměť okamžitě po dokončení uživatelem. Z prohlížeče objViewer.Close(true) odesílá ekvivalentní požadavek na zavření na DocImage.axd.

Závěry

  • Jeden otevřený dokument = jedna relace = jeden token, přidělený ASP.NET relaci, která jej otevřela.
  • Token vyprší po klouzavém časovém okně; viewer ponechaný nečinný déle než DocOptions.TimeOut potřebuje opětovné otevření.
  • Viewer může být získán a volně sdílen; relace nesou celý stav.

Byla tato stránka užitečná?