إعداد الترخيص

المكان الذي يبحث فيه Doconut عن ملف الترخيص الخاص بك

بدون ترخيص، لا يزال Doconut يعرض المستندات — كل صفحة تحمل علامة مائية للتقييم فقط. تغطي هذه الصفحة الطرق الأربع لتوفير ترخيص، والترتيب الدقيق عندما يتم تعيين أكثر من واحد.

يتم تحميل الترخيص مرة واحدة، أثناء AddDoconut(). هذا تغيير عن مكتبة .NET Standard السابقة، حيث كان يتم تمرير الترخيص إلى كائن Viewer أو تعيينه عبر استدعاءات Viewer.DoconutLicense(...) / Viewer.SetLicensePlugin(...) الثابتة. تلك الطرق ليست آلية بدء تشغيل في هذا الإصدار — راجع دليل الترحيل.

أربع طرق لتوفير ترخيص

هناك أربع: ثلاثة مصادر صريحة على DoconutOptions — تدفق، محتوى خام، أو مسار ملف — بالإضافة إلى الاكتشاف التلقائي عندما لا يتم تعيين أي منها. عندما يتم تعيين أكثر من واحد، يكون الترتيب دقيقًا:

LicenseStream يتفوق على LicenseContent يتفوق على LicensePath يتفوق على البحث التلقائي.

حسب المسار

LicensePath يتم تمريره إلى File.Exists كما هو بالضبط. يتم حل المسار النسبي بالنسبة إلى دليل العمل الحالي للعملية — ليس مجلد مشروعك، ولا المجلد الذي يعيش فيه Program.cs. إذا لم يتم حل المسار، لا يرمي Doconut استثناء ولا ليس يتراجع إلى البحث التلقائي — فهو ببساطة لا يحمل أي ترخيص وتظهر العلامة المائية للمشاهد. يعمل البحث التلقائي فقط عندما لا يتم تعيين أي من LicensePath أو LicenseContent أو LicenseStream. تُقرأ ملفات الترخيص الخاصة بكل مكوّن إضافي في نفس المجلد (Doconut.Viewer.<Capability>.lic) معها، لذا يعمل LicensePath وAddPlugin<...>() معًا عندما تكون تراخيص المكوّن الإضافي بجوار الترخيص الأساسي.

يفضل استخدام مسار مطلق (على سبيل المثال مبني من IWebHostEnvironment.WebRootPath أو AppContext.BaseDirectory)، أو تخطي LicensePath تمامًا والاعتماد على الاكتشاف التلقائي أدناه.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = Path.Combine(AppContext.BaseDirectory, "wwwroot", "Doconut.Viewer.lic");
});

عبر التدفق

LicenseStream يُقرأ مرة واحدة عند بدء التشغيل — مفيد عندما يأتي الترخيص من مخزن سري بدلاً من ملف على القرص.

csharp
// الأولوية: LicenseStream > LicenseContent > LicensePath > auto-search.
builder.Services.AddDoconut(options =>
{
    options.LicenseStream = licenseStream;
});

عبر المحتوى

LicenseContent يقبل نص الترخيص نفسه — من متغيّر بيئي، قاعدة بيانات، أو مدير أسرار:

csharp
// ملف XML للترخيص من قاعدة بيانات أو متغيّر بيئي أو مدير أسرار —
// لا ملف على القرص. لا يتفوق عليه سوى LicenseStream.
builder.Services.AddDoconut(options =>
{
    options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
});

الاكتشاف التلقائي

لا تقم بتكوين أي من المصادر الثلاثة الصريحة، وسيتبحث Doconut عن الترخيص بنفسه:

csharp
// لا تقم بأي إعداد، وسيبحث Doconut عن الترخيص نفسه، في هذين المجلدين فقط:
//   1. {CurrentDirectory}/wwwroot
//   2. {AppContext.BaseDirectory}/wwwroot   (wwwroot داخل مجلد مخرجات البناء)
// يبحث أولاً عن Doconut.lic؛ إذا كان مفقودًا، يبحث عن Doconut.Viewer.lic بالإضافة إلى أي
// ملفات Doconut.Viewer.<Capability>.lic حسب القدرة.
builder.Services.AddDoconut();

مجلدات الفحص، بالترتيب: أسماء الملفات، بالترتيب (يتم البحث عن كل اسم في المجلد الأول، ثم المجلد الثاني):

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-capability licenses, read only when Doconut.Viewer.lic was found

لا يتم قراءة أي شيء خارج مجلد wwwroot: يتم تجاهل .lic في مجلد الإخراج نفسه، أو في wwwroot/lib.

إذا كنت قد مررت مسبقًا List<string> لمسارات الترخيص إلى مُنشئ Viewer — واحد لكل قدرة — احتفظ بملفات المرافقة تلك بجوار Doconut.Viewer.lic ودع الاكتشاف التلقائي يلتقطها. لا يوجد خيار قائمة بالمسارات على DoconutOptions.

انسخ الترخيص إلى مجلد الإخراج الخاص بك

عندما لا يتم تشغيل العملية من مجلد المشروع — تطبيق منشور، IIS، حاوية، أو مُشغّل اختبار — الفحص الأول يفشل، والثاني، {AppContext.BaseDirectory}/wwwroot، يجب أن يجد الملف. هدف MSBuild هذا ينسخ التراخيص هناك في كل بناء:

xml
<Target Name="CopyLicensesToOutput" AfterTargets="Build">
  <ItemGroup>
    <DoconutLicenseFiles Include="$(MSBuildProjectDirectory)\wwwroot\*.lic" />
    <StaleOutputLicenses Include="$(OutDir)wwwroot\*.lic" />
  </ItemGroup>
  <!-- احذف أولاً، حتى أن إعادة تسمية أو إزالة .lic في wwwroot يزيله أيضاً من الناتج. -->
  <Delete Files="@(StaleOutputLicenses)" />
  <Copy SourceFiles="@(DoconutLicenseFiles)" DestinationFolder="$(OutDir)wwwroot" />
</Target>

يجب أن يكون الوجهة $(OutDir)wwwroot: الـ .lic المنسوخ إلى جذر الإخراج لا يتم العثور عليه أبدًا بواسطة البحث التلقائي. أمثلة LicensePath في هذه الصفحة تشير إلى نفس المكان.

احتفظ بملفات .lic خارج التحكم في المصدر — انشرها جنبًا إلى جنب مع التطبيق، أو أدخل الترخيص عبر LicenseContent أو LicenseStream من مخزن الأسرار الخاص بك.

ما يحدث بدون ترخيص

عدم وجود ترخيص لا يسبب استثناء. AddDoconut() ينجح، يبدأ التطبيق، ويعمل العارض — لكن كل صفحة تحمل علامة مائية للتقييم ولا تُمنح أي قدرة اختيارية.

ملف الترخيص الذي يتم العثور عليه لكنه مرفوض يختلف. توقيع غير صالح، تلاعب، إدراج في القائمة السوداء، أو بناء خارج نافذة إصدار الترخيص يسبب أن OpenDocumentAsync يرمي LicenseException مع License.RejectionMessage. الترخيص المؤقت المنتهي يستمر في وضع العلامة المائية. الترخيص المدفوع الذي تجاوز تاريخ اشتراكه يظل يعمل، نظيفًا ومع قدراته، في كل بناء يُصدر قبل ذلك التاريخ.

الإضافات تحتاج إلى قدرات

تسجيل إضافة بدون استحقاق مطابق يختلف: بالنسبة لترخيص مفقود، ملف TRIAL قديم، أو ترخيص مدفوع بدون تلك القدرة، AddDoconut() يرمي InvalidOperationException، لذا لا يبدأ التطبيق. على سبيل المثال، تسجيل إضافة Converter بدون ترخيص يمنح Converter:

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.

الرسالة تخبرك بالإصلاح مباشرةً: إما إزالة استدعاء options.AddPlugin<...>() لتلك الإضافة، أو تثبيت ترخيص مدفوع أو ترخيص مؤقت/تجريبي (NFR) نشط يمنح القدرة. يُسمح للتسجيلات المؤقتة بالبقاء بعد تاريخ انتهاء صلاحيتها حتى يتمكن التطبيق المُكوَّن مسبقًا من التراجع أثناء التشغيل بدلاً من التعطل أثناء إعادة التشغيل؛ بمجرد انتهاء الصلاحية، تُسحب قدراتهم.

تحقق من الترخيص المحمَّل

استخدم IDoconutLicenseService، نفس مصدر الحقيقة المستخدم من قبل SDK، لكشف نقطة تشخيص موثوقة أو لتفعيل علامات المميزات. لا تُرجع محتويات الترخيص أو المفاتيح.

csharp
app.MapGet("/api/doconut/license", (IDoconutLicenseService license) => Results.Ok(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
}));

يُقرأ الترخيص أثناء تسجيل AddDoconut(). ResetLicense هو حاليًا خاصية توافقية بدون مسار إعادة تحميل نشط، لذا استبدال ملف الترخيص يتطلب إعادة تشغيل التطبيق.

مصفوفة استكشاف الأخطاء وإصلاحها

العَرَضالسبب المحتملالتحقق
العارض يعمل لكن كل صفحة تحمل علامة مائيةلم يتم تحميل أي ترخيص، أو انتهت صلاحية الترخيص المؤقتحل IDoconutLicenseService؛ تحقق من دليل الإخراج ودليل عمل العملية
AddDoconut() يرمي لإضافةالترخيص لا يمنح قدرة تلك الإضافةتحقق من IsCapabilityGranted(...) وأزل التسجيلات التي لم تشترِها
مسار نسبي مُكوَّن يعمل محليًا لكنه لا يعمل في IIS/حاويةدليل عمل العملية تغيراستخدم AppContext.BaseDirectory أو مسارًا مطلقًا
استبدال ملف .lic لا يؤثرتم إنشاء خدمة الترخيص المفردة بالفعلأعد تشغيل التطبيق
OpenDocumentAsync يرمي LicenseExceptionالتوقيع، النطاق، نافذة الإصدار، القائمة السوداء، أو بوابة تشغيل الإضافة رفضت الترخيصاقرأ رسالة الاستثناء/الرفض دون كشفها للعملاء غير الموثوق بهم
ترخيص حسب القدرة كان يعمل سابقًا لكنه لا يعمل الآنالكود القديم مرّر مسارات ترخيص صريحة إلى مُنشئ Viewerانقل ملفات .lic المرافقة بجوار Doconut.Viewer.lic ودع الاكتشاف التلقائي يحملها

الخطوات التالية

هل كانت هذه الصفحة مفيدة؟