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

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

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

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

هناك أربع: ثلاثة مصادر صريحة على 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 > البحث التلقائي.
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-plugin licenses, read only when Doconut.Viewer.lic was found

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

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

عندما لا تعمل العملية من مجلد المشروع — تطبيق منشور، 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التوقيع، النطاق، نافذة الإصدار، القائمة السوداء، أو بوابة تشغيل الإضافة رفضت الترخيصاقرأ رسالة الاستثناء/الرفض دون كشفها للعملاء غير الموثوق بهم

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

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

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