راه‌اندازی مجوز

محل جستجوی Doconut برای فایل مجوز شما در IIS

بدون داشتن مجوز، Doconut همچنان اسناد را رندر می‌کند — هر صفحه فقط یک واترمارک ارزیابی دارد. این صفحه چهار روش برای فراهم کردن مجوز در Global.asax، مکان‌هایی که Doconut هنگام عدم ارائه مجوز جستجو می‌کند، و آنچه هنگام عدم وجود مجوز یک افزونه رخ می‌دهد را پوشش می‌دهد.

چهار روش برای فراهم کردن مجوز

سه منبع صریح در DoconutOptions وجود دارد — مسیر فایل، جریان، یا محتوای خام — به‌علاوه کشف خودکار وقتی هیچ‌یک از آن‌ها تنظیم نشده باشد. همه آن‌ها یک‌بار در DoconutHost.Initialize خوانده می‌شوند. وقتی بیش از یک منبع تنظیم شود، اولویت به‌دقت به‌صورت زیر است:

LicenseStream برتری دارد بر LicenseContent برتری دارد بر LicensePath برتری دارد بر کشف خودکار.

بر اساس مسیر

به LicensePath یک مسیر کامل بدهید. مسیر نسبی نسبت به پوشه جاری فرآیند حل می‌شود و تحت IIS این پوشه، پوشهٔ فرآیند کارگر است، نه سایت شما. HostingEnvironment.MapPath مسیر نسبی سایت را به مسیر کامل تبدیل می‌کند:

csharp
Doconut.DoconutHost.Initialize(options =>
{
    options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
});

اگر فایل وجود نداشته باشد، Doconut خطا نمی‌اندازد و به کشف خودکار باز نمی‌گردد: هیچ مجوزی بارگذاری نمی‌شود و نمایشگر واترمارک می‌گذارد. فایل‌های مجوز مربوط به هر افزونه در همان پوشه (Doconut.Viewer.<Capability>.lic) همراه با آن خوانده می‌شوند، بنابراین LicensePath و AddPlugin<...>() به‌صورت همزمان کار می‌کنند وقتی مجوزهای افزونه در کنار مجوز اصلی قرار دارند.

از طریق جریان

LicenseStream یک‌بار در زمان راه‌اندازی خوانده می‌شود — مفید زمانی که مجوز از یک منبع جاسازی‌شده یا یک مخزن مخفی می‌آید نه از یک فایل روی دیسک.

csharp
// اولویت: LicenseStream > LicenseContent > LicensePath > جستجوی خودکار.
Doconut.DoconutHost.Initialize(options =>
{
    options.LicenseStream = licenseStream;
});

از طریق محتوا

LicenseContent متن خود مجوز را می‌گیرد — از یک متغیر محیطی، پایگاه داده یا مخزن مخفی — بنابراین نیازی به استقرار فایل مجوز همراه با سایت نیست.

csharp
// XML مجوز از پایگاه داده، یک متغیر محیطی یا یک مخزن راز -
// هیچ فایلی روی دیسک نیست. فقط توسط LicenseStream پیشی گرفته می‌شود.
Doconut.DoconutHost.Initialize(options =>
{
    options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});

کشف خودکار

هیچ‌یک از سه گزینه را تنظیم نکنید، و Doconut خود به‌دنبال مجوز می‌گردد:

csharp
// هیچ‌چیزی پیکربندی نشود، و Doconut خود به‌دنبال لایسنس می‌گردد، به این ترتیب:
//   1. {CurrentDirectory}\wwwroot
//   2. {AppContext.BaseDirectory}\wwwroot   (در زیر IIS: پوشه ریشه سایت)
// اول به دنبال Doconut.lic می‌گردد؛ اگر آن موجود نباشد، Doconut.Viewer.lic به‌همراه هر
// فایل‌های Doconut.Viewer.<Capability>.lic مربوط به هر افزونه.
Doconut.DoconutHost.Initialize();

دو پوشه، به ترتیب، و فایل‌هایی که جستجو می‌شوند:

text
1. {CurrentDirectory}\wwwroot
2. {AppContext.BaseDirectory}\wwwroot

Filenames, in order (each one looked for in folder 1, then folder 2):
  Doconut.lic                        — legacy all-in-one license; if found, nothing else is read
  Doconut.Viewer.lic                 — base viewer license
  Doconut.Viewer.<Capability>.lic    — per-plugin licenses, read only when Doconut.Viewer.lic was found

در IIS و IIS Express، AppContext.BaseDirectory پوشه ریشهٔ سایت است — پوشه‌ای که Web.config را در خود دارد — نه پوشهٔ bin آن. بنابراین مجوز باید در wwwroot زیر ریشهٔ سایت قرار گیرد:

text
MySite\
  Web.config
  Global.asax
  bin\
  wwwroot\
    Doconut.Viewer.lic
    Doconut.Viewer.Converter.lic

در پروژه، wwwroot\*.lic را کنار Web.config نگه دارید و پوشه را همراه با سایت استقرار دهید. نیازی به مرحلهٔ ساخت برای کپی کردن آن نیست. یک .lic در جای دیگر — در bin\، کنار Web.config، یا در زیرپوشه‌ای از wwwroot — هرگز خوانده نمی‌شود.

فایل‌های .lic را خارج از کنترل نسخه نگه دارید. آن‌ها را همراه با سایت استقرار دهید، یا مجوز را از طریق LicenseContent یا LicenseStream از مخزن مخفی خود فراهم کنید.

چه اتفاقی می‌افتد بدون مجوز

یک مجوز گمشده خطایی نمی‌اندازد. DoconutHost.Initialize موفق می‌شود، سایت شروع می‌شود و نمایشگر اجرا می‌شود، اما هر صفحه دارای علامت آب‌شده ارزیابی است و هیچ قابلیت اختیاری اعطا نمی‌شود.

یک فایل مجوز که پیدا می‌شود اما رد می‌شود متفاوت است. یک امضای نامعتبر، دستکاری، یا ساختی خارج از بازه نسخه مجوز باعث می‌شود OpenDocumentAsync با LicenseException به همراه دلیل پرتاب شود. یک مجوز موقت منقضی شده به حالت علامت‌گذاری ادامه می‌دهد. یک مجوز پرداخت‌شده که تاریخ اشتراک آن گذشته است، همچنان کار می‌کند، بدون علامت و با قابلیت‌های خود، بر روی هر ساختی که قبل از آن تاریخ منتشر شده باشد.

افزونه‌ها به مجوز خود در زمان راه‌اندازی نیاز دارند

ثبت یک افزونه‌ای که هیچ مجوزی قابلیت آن را اعطا نمی‌کند، برنامه را در زمان راه‌اندازی متوقف می‌کند. DoconutHost.Initialize در Application_Start پرتاب می‌شود:

text
InvalidOperationException: The Converter plugin is registered via AddPlugin but no active
license grants Converter. Remove the AddPlugin<...>() call or install a license (or
trial/demo) that includes Converter.

در زیر System.Web، این پیام را در مرورگر نمی‌بینید. هر درخواست به سایت یک 500 خالی پاسخ می‌دهد — بدون صفحه خطا، بدون ردیابی پشته، هیچ چیزی در لاگ IIS نیست. استثنا فقط در Windows event log (لاگ برنامه، منبع ASP.NET) ثبت می‌شود. اگر کل سایت بلافاصله پس از افزودن یک خط AddPlugin متوقف شود، فایل‌های مجوز را در wwwroot قبل از کد بررسی کنید: Doconut.Viewer.<Capability>.lic افزونه باید در کنار Doconut.Viewer.lic قرار گیرد، و بدون مجوز پایه فایل‌های افزونه اصلاً خوانده نمی‌شوند.

تأیید مجوز بارگذاری‌شده

IDoconutLicenseService همان منبع حقیقتی است که SDK استفاده می‌کند. آن را از DoconutHost.Services حل کنید تا یک نقطه انتهایی تشخیصی معتبر را افشا کنید یا پرچم‌های ویژگی را هدایت کنید — هرگز محتوای مجوز را برنگردانید:

csharp
// GET /License/Status
public ActionResult Status()
{
    var license = Doconut.DoconutHost.Services.GetRequiredService<IDoconutLicenseService>();

    return Json(new
    {
        viewer     = license.IsViewerLicensed || license.IsTemporary,
        temporary  = license.IsTemporary,
        search     = license.IsCapabilityGranted(LicenseCapability.Search),
        annotation = license.IsCapabilityGranted(LicenseCapability.Annotation),
        converter  = license.HasConverter,
        dicom      = license.HasDicom
    }, JsonRequestBehavior.AllowGet);
}

مجوز یک‌بار در DoconutHost.Initialize خوانده می‌شود. پس از جایگزینی یک فایل مجوز، استخر برنامه را بازچرخانی کنید (یا Web.config را لمس کنید) تا Application_Start دوباره اجرا شود.

عیب‌یابی

علامتدلیل محتملبررسی
نمایشگر کار می‌کند اما هر صفحه علامت‌گذاری شده استمجوزی یافت نشدآیا .lic در <site root>\wwwroot قرار دارد؟ endpoint وضعیت بالا را فراخوانی کنید
هر درخواست پس از افزودن یک افزونه، یک 500 خالی پاسخ می‌دهدیک افزونه ثبت‌شده مجوزی برای آن اعطا نکرده استلاگ رویداد ویندوز، منبع ASP.NET؛ .lic افزونه در کنار Doconut.Viewer.lic
LicensePath روی دستگاه شما کار می‌کند اما روی سرور نیستیک مسیر نسبی که نسبت به پوشه فرآیند کارگر حل می‌شودبا HostingEnvironment.MapPath("~/wwwroot/...") بسازید
یک فایل .lic جایگزین شده تأثیری نداردمجوز هنگام شروع برنامه خوانده شداستخر برنامه را بازچرخانی کنید
OpenDocumentAsync پرتاب می‌کند LicenseExceptionمجوز یافت شد اما رد شدپیام استثنا را بخوانید؛ آن را به مشتریان غیرقابل اعتماد نشان ندهید

گام‌های بعدی

  • مجوزدهی — قابلیت‌ها، و چگونگی بررسی آن‌ها در زمان اجرا.
  • عیب‌یابی — علامت‌گذاری‌ها، شکست‌های راه‌اندازی، و سایر علائم.

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