Wie der Viewer funktioniert

Der Lebenszyklus von Dokumentanfragen

Doconut rendert Dokumente als paginierte Bilder, die von einem HTTP‑Handler bereitgestellt werden, den Ihr Web.config registriert. Das Verständnis des Lebenszyklus — Öffnen, Token, Seitenanfragen, Schließen — erklärt fast jedes Verhalten, das Sie beobachten werden, einschließlich der Fehlermeldungen.

Die Komponenten

  • Viewer — der öffentliche Dienst, den Sie aus DoconutHost.Services auflösen. Er öffnet Dokumente und gibt Sitzungs‑Tokens zurück.
  • Die Dokumentensitzung — ein serverseitiges Objekt, das das geladene Dokument hält und im Speicher unter seinem Token aufbewahrt wird.
  • DocImage.axd — das Doconut.DocImageHandler, das in Web.config deklariert ist. Es beantwortet jede Anfrage, die das Browser‑Widget stellt (Seiten, Thumbnails, Suche, Anmerkungen, …), immer identifiziert durch das Token.
  • /doconut-res/* — das Doconut.DoconutResourceModule, das die eigenen Skripte, Styles und Icons des Widgets bereitstellt.

Viewer ist zustandslos — per Design

Viewer hält keinen pro‑Anfrage‑Dokumentzustand und implementiert nicht IDisposable. Sitzungen existieren unabhängig davon und werden durch Ablauf oder ein explizites CloseDocument(token) bereinigt. System.Web hat keine Konstruktor‑Injection, daher lösen Sie es dort auf, wo Sie es benötigen — typischerweise in einer Controller‑Aktion:

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");
}

Was passiert innerhalb von OpenDocumentAsync

  1. Lizenzschranke. Eine abgelehnte Lizenz (manipuliert, gesperrt oder ein Build außerhalb des Aktualisierungsfensters der Lizenz) wirft sofort LicenseException, wobei der Grund als Meldung angegeben wird. Das Öffnen degradert niemals stillschweigend bei einer ungültigen Lizenz; eine fehlende Lizenz fügt nur ein Wasserzeichen hinzu.
  2. Sitzungserstellung. Die Viewer‑Factory wählt den Format‑Viewer für die Dateierweiterung aus und lädt das Dokument (siehe Rendering Pipeline). Die Sitzung wird im Speicher unter einem neuen zufälligen Token mit einer gleitenden Ablaufzeit von DocOptions.TimeOut Minuten (Standard 60) gespeichert. Jede Seitenanfrage setzt die Uhr zurück.
  3. Zugriffsgewährung. Mit UnsafeMode = false (der Vorgabe) ist das Token an die ASP.NET‑Sitzung der Anfrage gebunden, die es geöffnet hat: ein secure-{token}‑Eintrag wird in diese Sitzung geschrieben. Das Öffnen muss daher in einer Anfrage mit Sitzungszustand ausgeführt werden — siehe Sessions & Security.
  4. Das Token wird zurückgegeben. Es ist der einzige Bezeichner, den der Browser für alles Weitere benötigt.

Die asynchronen Überladungen akzeptieren einen Dateipfad, einen Dateipfad plus eine pro‑Format‑Konfiguration (PdfConfig, WordConfig, …) oder ein Stream plus ein FileInfo, dessen Erweiterung das Format bestimmt. Für Web‑Forms‑Code‑Behind, das keine asynchronen Seiten verwendet, bietet OpenDocument dieselben drei Eingaben synchron an (ein Pfad, ein Stream mit Dateinamen oder ein Byte‑Array mit Dateinamen).

Wie das Widget Seiten erhält

Das Widget ruft DocImage.axd mit dem Token in der Abfragezeichenfolge auf. Was der Handler tut, hängt von der Anfrage ab:

AbfrageZweck
?token=…&page=NGerendertes Seitenbild (PNG)
?token=…&page=N&thumb=1Vorschaubild
?token=…&zoom=…Vergrößerte Seitenrenderung
?token=…&search=termVolltextsuche (lizenzgesteuert)
?token=…&bookmarksDokumentgliederung und Lesezeichen
?token=…&copy / &showlinks / &fileFormatTextkopie, Hyperlinks und Formatinformationen
?token=…&metaDICOM‑technische Metadaten — in diesem Paket nicht verfügbar (antwortet 404)
?token=…&action=rotate/flip/closeSeitenaktionen und explizites Schließen (POST)
?token=…&AnnSave=… / &AnnLoadSpeichern und Laden von Anmerkungen

Jede Anfrage wird zuerst geprüft:

  • Kein Token → 404, oder ein Versionsbanner, wenn ShowDoconutInfo = true.
  • Token nicht dieser ASP.NET‑Sitzung zugewiesen → ein Fehlermotiv mit dem Text You Are Not Authorized To View This Page.
  • Unbekanntes oder abgelaufenes Token → ein Fehlermotiv mit dem Text Document session not found. Please re-open document.

Die Fehlermotive sind gewöhnliche PNGs, die mit dem Status 200 gesendet werden, sodass das Widget sie dort anzeigen kann, wo die Seite stehen würde. Eine Überwachungsprüfung, die nur den Statuscode betrachtet, meldet sie als ausgelieferte Seiten; eine echte Seite hat mehrere zehn bis mehrere hundert Kilobyte, ein Fehlermotiv etwa 2 KB.

Schließen eines Dokuments

csharp
viewer.CloseDocument(token);

CloseDocument entfernt die Sitzung (gibt die Dokumenten‑Engine und deren Speicher sofort frei), entfernt den secure-{token}‑Eintrag aus der ASP.NET‑Sitzung der aktuellen Anfrage und widerruft das Token. Es ist optional — die gleitende Ablaufzeit führt dieselbe Bereinigung durch — aber bei großen Dokumenten wird der Speicher sofort freigegeben, sobald der Benutzer fertig ist. Vom Browser aus sendet objViewer.Close(true) die entsprechende Schließ‑Anfrage an DocImage.axd.

Fazit

  • Ein geöffnetes Dokument = eine Sitzung = ein Token, das der ASP.NET‑Sitzung zugewiesen wird, die es geöffnet hat.
  • Das Token läuft nach einem gleitenden Zeitfenster ab; ein Viewer, der länger als DocOptions.TimeOut untätig ist, muss erneut geöffnet werden.
  • Viewer kann frei aufgelöst und geteilt werden; die Sitzungen tragen den gesamten Zustand.

War diese Seite hilfreich?