ビューアの仕組み

ドキュメントリクエストのライフサイクル

Doconut はドキュメントをページ分割された画像としてレンダリングし、Web.config が登録する HTTP ハンドラで配信します。ライフサイクル(オープン、トークン、ページリクエスト、クローズ)を理解することで、エラーメッセージを含むほぼすべての挙動を説明できます。

動く部品

  • Viewer — DoconutHost.Services から解決するパブリックサービスです。ドキュメントを開き、セッショントークンを返します。
  • The document session — 読み込まれたドキュメントを保持し、トークンの下でメモリに保持されるサーバー側オブジェクトです。
  • DocImage.axd — Web.config で宣言された Doconut.DocImageHandler です。ブラウザウィジェットが行うすべてのリクエスト(ページ、サムネイル、検索、注釈、…)に応答し、常にトークンで識別されます。
  • /doconut-res/* — ウィジェット自身のスクリプト、スタイル、アイコンを提供する Doconut.DoconutResourceModule です。

Viewer はステートレス — 設計上

Viewer はリクエストごとのドキュメント状態を保持せず、IDisposable を実装していません。セッションはそれとは独立して存在し、期限切れまたは明示的な CloseDocument(token) によってクリーンアップされます。System.Web にはコンストラクタインジェクションがないため、必要な場所で解決してください — 通常はコントローラアクション内です:

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

OpenDocumentAsync の内部で何が起こるか

  1. ライセンスゲート。 拒否されたライセンス(改ざん、ブラックリスト登録、またはライセンスの更新ウィンドウ外のビルド)は、LicenseException を即座にスローし、理由をメッセージとして提供します。無効 ライセンスの場合、オープンは決して静かに劣化せず、欠如 ライセンスの場合は透かしが付くだけです。
  2. セッション作成。 ビューワーファクトリはファイル拡張子に対応するフォーマットビューワーを選択し、ドキュメントをロードします(Rendering Pipeline を参照)。セッションは新しいランダムトークンの下でメモリに保存され、DocOptions.TimeOut 分の スライディング有効期限(デフォルト 60)を持ちます。各ページリクエストで時計がリセットされます。
  3. アクセス付与。 デフォルトの UnsafeMode = false を使用すると、トークンは それを開いたリクエストの ASP.NET セッション にバインドされます:secure-{token} エントリがそのセッションに書き込まれます。したがって、オープンはセッションステートを持つリクエストで実行する必要があります — Sessions & Security を参照してください。
  4. トークンが返されます。 それは、以降のすべてでブラウザが必要とする唯一の識別子です。

非同期オーバーロードは、ファイルパス、ファイルパスとフォーマット別設定(PdfConfig、WordConfig、…)の組み合わせ、または拡張子でフォーマットを選択する Stream と FileInfo を受け取ります。非同期ページを使用しない Web Forms のコードビハインドの場合、OpenDocument は同じ 3 つの入力(パス、ファイル名付きストリーム、またはファイル名付きバイト配列)を同期的に提供します。

ウィジェットがページを取得する方法

ウィジェットはクエリ文字列にトークンを付けて DocImage.axd を呼び出します。ハンドラの動作はリクエストに依存します:

QueryPurpose
?token=…&page=Nレンダリングされたページ画像(PNG)
?token=…&page=N&thumb=1サムネイル
?token=…&zoom=…拡大ページのレンダリング
?token=…&search=term全文検索(ライセンス制御)
?token=…&bookmarksドキュメントアウトラインとブックマーク
?token=…&copy / &showlinks / &fileFormatテキストコピー、ハイパーリンク、フォーマット情報
?token=…&metaDICOM 技術メタデータ — このパッケージでは利用できません(404 が回答)
?token=…&action=rotate/flip/closeページアクションと明示的なクローズ(POST)
?token=…&AnnSave=… / &AnnLoad注釈の保存と読み込み

すべてのリクエストは最初にチェックされます:

  • トークンなし → 404、または ShowDoconutInfo = true の場合はバージョンバナー。
  • この ASP.NET セッションに付与されていないトークン → You Are Not Authorized To View This Page. と表示されるエラー画像
  • 不明または期限切れのトークン → Document session not found. Please re-open document. と表示されるエラー画像

エラー画像はステータス 200 で送信される普通の PNG で、ウィジェットはページがあるべき場所にそれらを表示できます。ステータスコードだけを確認する監視チェックはそれらを配信されたページとして報告します;実際のページは数十〜数百キロバイトで、エラー画像は約 2 KB です。

ドキュメントのクローズ

csharp
viewer.CloseDocument(token);

CloseDocument はセッションを削除し(ドキュメントエンジンとそのメモリを即座に解放)、現在のリクエストの ASP.NET セッションから secure-{token} エントリを削除し、トークンを無効化します。これはオプションです — スライディング有効期限が同じクリーンアップを行います — が、大きなドキュメントの場合、ユーザーが完了した瞬間にメモリを解放します。ブラウザ側からは、objViewer.Close(true) が同等のクローズリクエストを DocImage.axd に送信します。

まとめ

  • 1 つのオープンドキュメント = 1 つのセッション = 1 つのトークンで、オープンした ASP.NET セッションに付与されます。
  • トークンはスライディングウィンドウで期限切れになります;DocOptions.TimeOut を過ぎてアイドル状態のままのビューアは再オープンが必要です。
  • Viewer は自由に解決して共有できます;セッションがすべての状態を保持します。

このページは役に立ちましたか?