نحوه کار Viewer

دورهٔ درخواست سند

Doconut اسناد را به‌صورت تصاویر صفحه‌بندی‌شده رندر می‌کند که توسط یک HTTP handler که Web.config شما ثبت می‌کند سرو می‌شود. درک دورهٔ حیات — باز کردن، توکن، درخواست‌های صفحه، بسته شدن — تقریباً تمام رفتارهایی که مشاهده می‌کنید، از جمله پیام‌های خطا را توضیح می‌دهد.

اجزای متحرک

  • Viewer — سرویس عمومی که از DoconutHost.Services حل می‌کنید. این سرویس اسناد را باز می‌کند و توکن‌های جلسه را برمی‌گرداند.
  • جلسهٔ سند — شیء سمت‑سرور که سند بارگذاری‌شده را نگه می‌دارد و تحت توکن خود در حافظه نگهداری می‌شود.
  • DocImage.axd — Doconut.DocImageHandler اعلام‌شده در Web.config. این سرویس به هر درخواست ویجت مرورگر (صفحات، تصویرهای کوچک، جستجو، حاشیه‌نویسی‌ها، …) پاسخ می‌دهد و همیشه با توکن شناسایی می‌شود.
  • /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 دقیقه (پیش‌فرض ۶۰) ذخیره می‌شود. هر درخواست صفحه ساعت را ریست می‌کند.
  3. اعطای دسترسی. با UnsafeMode = false (پیش‌فرض)، توکن به جلسهٔ ASP.NET درخواست‌کننده‌ای که آن را باز کرده متصل می‌شود: یک ورودی secure-{token} در آن جلسه نوشته می‌شود. بنابراین باز کردن باید در درخواست با وضعیت جلسه اجرا شود — به Sessions & Security مراجعه کنید.
  4. توکن بازگردانده می‌شود. این تنها شناسه‌ای است که مرورگر برای تمام موارد بعدی نیاز دارد.

بارگذاری‌های ناهمزمان یک مسیر فایل، یک مسیر فایل به‌همراه پیکربندی هر‑فرمت (PdfConfig، WordConfig، …) یا یک Stream به‌همراه یک FileInfo که پسوند آن فرمت را انتخاب می‌کند، می‌پذیرند. برای کد‑پشت Web Forms که از صفحات ناهمزمان استفاده نمی‌کند، OpenDocument همان سه ورودی را به‌صورت همزمان ارائه می‌دهد (یک مسیر، یک جریان با نام فایل، یا یک آرایه بایت با نام فایل).

چگونگی دریافت صفحات توسط ویجت

ویجت با توکن در رشتهٔ پرس‌وجو، DocImage.axd را فراخوانی می‌کند. کاری که هندلر انجام می‌دهد به درخواست بستگی دارد:

درخواستهدف
?token=…&page=Nتصویر صفحه رندر شده (PNG)
?token=…&page=N&thumb=1تصویر کوچک
?token=…&zoom=…رندر صفحه بزرگ‌نمایی‌شده
?token=…&search=termجستجوی تمام متن (محدود به مجوز)
?token=…&bookmarksطرح کلی سند و نشانک‌ها
?token=…&copy / &showlinks / &fileFormatکپی متن، پیوندها، و اطلاعات فرمت
?token=…&metaمتادیتای فنی DICOM — در این بسته موجود نیست (پاسخ‌ها 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.

تصاویر خطا PNGهای معمولی هستند که با وضعیت 200 ارسال می‌شوند، بنابراین ویجت می‌تواند آن‌ها را در جایی که صفحه قرار می‌گیرد نمایش دهد. یک بررسی مانیتورینگ که فقط به کد وضعیت نگاه می‌کند، آن‌ها را به‌عنوان صفحات سرو‌شده گزارش می‌دهد؛ یک صفحهٔ واقعی چندین تا صد کیلوبایت است، در حالی که تصویر خطا حدود ۲ کیلوبایت است.

بستن یک سند

csharp
viewer.CloseDocument(token);

CloseDocument جلسه را حذف می‌کند (موتور سند و حافظهٔ آن را بلافاصله آزاد می‌کند)، ورودی secure-{token} را از جلسهٔ ASP.NET درخواست جاری حذف می‌کند و توکن را باطل می‌سازد. این کار اختیاری است — انقضای لغزان همان پاک‌سازی را انجام می‌دهد — اما برای اسناد بزرگ، حافظه را به‌محض پایان کار کاربر آزاد می‌کند. از مرورگر، objViewer.Close(true) درخواست بسته شدن معادل را به DocImage.axd می‌فرستد.

نکات کلیدی

  • یک سند باز = یک جلسه = یک توکن، که به جلسهٔ ASP.NET که آن را باز کرده اعطا می‌شود.
  • توکن در یک بازهٔ لغزان منقضی می‌شود؛ یک Viewer که بیش از DocOptions.TimeOut بیکار بماند نیاز به بازگشایی دارد.
  • Viewer می‌تواند آزادانه حل و به‌اشتراک گذاشته شود؛ جلسات تمام وضعیت را حمل می‌کنند.

آیا این صفحه مفید بود؟