Лицензирование

Возможности, уровни лицензий и сервис лицензий

Эта страница — справочник во время выполнения о том, как лицензия определяет поведение Doconut: что позволяет каждое состояние лицензии, как предоставляются возможности и как проверить всё это из кода. (Для загрузки лицензии см. Настройка лицензии.)

Состояния лицензий и их функции

СостояниеОткрывает документы?Водяной знакВозможности
Полная (платная) лицензия (эта сборка была выпущена до даты её подписки)ДаНетПриобретённые (Has* флаги)
Временная лицензия (Developer/NFR — оценочная лицензия, до даты её истечения)ДаОтсутствует в базовом просмотрщике; вывод плагина имеет водяной знакВсе — универсальное предоставление (оценочный воронка)
Истёкшая временная лицензия (после её даты LicenseExpiry)ДаВодяной знак оценкиНичего не предоставлено
Отсутствует файл лицензииДаВодяной знак оценкиНичего не предоставлено
Найдена, но отклонена (недействительная подпись, изменена, в чёрном списке, или сборка выпущена после даты подписки лицензии)Нет — LicenseException при каждом открытии——

Платная лицензия, у которой прошла дата подписки, продолжает работать — без водяных знаков, со своими возможностями — на любой сборке, выпущенной до этой даты. Только сборка, выпущенная после неё, отклоняется.

Два последствия, которые стоит усвоить:

  • Отсутствующая лицензия не является временной лицензией. При отсутствии файла лицензии страницы отображаются с водяным знаком, и никакая возможность (поиск, аннотация, плагины) не активна. Полнофункциональный опыт без водяных знаков требует реальной Временной лицензии (получить её).
  • Только отклонённая лицензия блокирует открытие. Истёкшая Временная лицензия позволяет приложению работать с водяным знаком оценки, а платная лицензия после даты подписки продолжает отображаться без водяных знаков на поддерживаемых сборках; однако развертывание сборки, выпущенной после даты подписки лицензии, отклоняется и быстро завершается с ошибкой через LicenseException, поэтому вы обнаруживаете её при развертывании — а не тихо поставляя вывод с водяным знаком. Это исключение (из OpenDocumentAsync) содержит причину из License.RejectionMessage.

Возможности

Doconut ограничивает дополнительный функционал через возможность. Это охватывает встроенные функции Поиск и Аннотация, а также подключаемые плагины Converter, Dicom и Signer, каждый из которых предоставляется вашей лицензией. Базовый просмотрщик не является возможностью — он является предварительным условием, представляемым как IsViewerLicensed:

csharp
var lic = Doconut.DoconutHost.Services.GetRequiredService<IDoconutLicenseService>();
bool viewerLicensed = lic.IsViewerLicensed; // non-TRIAL лицензия присутствует AND покрывающая версию этой сборки

Единственный шлюз, который использует весь конвейер, — IsCapabilityGranted:

csharp
var lic = Doconut.DoconutHost.Services.GetRequiredService<IDoconutLicenseService>();
bool searchGranted = lic.IsCapabilityGranted(LicenseCapability.Search);

Её логика, дословно из реализации: активная (неистёкшая) Временная лицензия предоставляет все возможности — включая те, для которых ещё нет отдельного флага покупки; реальная приобретённая лицензия предоставляет точно свои флаги Has* и имеет по умолчанию отказ для любого не сопоставленного. (Устаревший файл типа TRIAL не является правом — он рассматривается как нелицензированный: с водяным знаком, ничего не предоставлено.)

Временные лицензии

Временные (Developer/NFR) лицензии отмечаются тегом ExpiryNote и имеют жёсткую дату истечения:

ЭлементЗначение
IsTemporaryТег ExpiryNote присутствует (обнаружение происходит по наличию тега — никогда не сравнивайте с текстом заметки, это динамично)
ExpiryNoteИнформационный текст, встроенный в лицензию
LicenseExpiryЖёсткая дата истечения (DateTime?)

Семантика истечения зависит от уровня: временная лицензия истекает в соответствии с её LicenseExpiry только датой (окно подписки игнорируется; временная лицензия без даты считается истёкшей, безопасный отказ). Все остальные лицензии истекают по дате их окна подписки/обновления; для платной лицензии IsExpired только сообщает, что эта дата прошла — сборки, выпущенные до неё, остаются чистыми и сохраняют свои возможности.

Ссылка на IDoconutLicenseService

Разрешить IDoconutLicenseService (пространство имён Doconut.Core.Interfaces) из DoconutHost.Services. Это singleton — лицензия разбирается один раз, в DoconutHost.Initialize:

ЭлементЗначение
LicenseПолный снимок DoconutLicenseInfo (см. ниже)
IsTrialУстаревший файл типа TRIAL (рассматривается как нелицензированный — не является правом)
IsTemporary / ExpiryNote / LicenseExpiryМаркеры временной лицензии
IsExpiredИстёк согласно правилам уровня выше
IsVersionValidЭта сборка попадает в окно поддержки лицензии
IsViewerLicensedНайден файл, не являющийся TRIAL и версия покрыта — базовое требование
IsCapabilityGranted(cap)Единственный шлюз возможностей
HasSearch HasAnnotation HasEditor HasConverter HasDicom HasDocumentTools HasSigner HasRedactor HasComparer HasForms HasProtector HasCompressorОдин флаг на возможность: приобретён лицензией, покрывающей эту сборку, или предоставлен активной временной лицензией. IsCapabilityGranted отвечает на тот же вопрос по возможности
IsValidForDomain(host)Покрытие хоста; лицензии V4 используют подстановочный символ *.*
LicenseRejectionReasonНе пусто ⇒ открытие блокируется этим сообщением

DoconutLicenseInfo предоставляет удобный для отображения снимок для административных панелей: Owner, LicenseType, Domain, IsLicenseFileFound, IsVersionValid, IsTrial, IsExpired, флаги Has*, поля временной лицензии и RejectionMessage.

csharp
// GET /Features - управляйте флагами функций вашего UI из того же источника правды, который использует SDK
public ActionResult Index()
{
    var lic = Doconut.DoconutHost.Services.GetRequiredService<IDoconutLicenseService>();

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

Проверка состояния

Doconut регистрирует проверку состояния "doconut", которая сообщает состояние лицензии. У Classic ASP.NET нет собственного эндпоинта состояния, поэтому откройте её через контроллер:

csharp
// GET /Health - Doconut регистрирует проверку состояния "doconut", которая сообщает о состоянии лицензии:
// Здоровый (действительный), Ухудшенный (пробный или отсутствует файл лицензии), Нездоровый (отклонён или просрочен).
public async Task<ActionResult> Index()
{
    var health = Doconut.DoconutHost.Services.GetRequiredService<HealthCheckService>();
    HealthReport report = await health.CheckHealthAsync();

    Response.StatusCode = report.Status == HealthStatus.Unhealthy ? 503 : 200;
    return Content(report.Status.ToString(), "text/plain");
}

Подключите её к вашей системе мониторинга, и истекающая подписка превратится в оповещение вместо тикета в поддержку. Проверка сообщает Unhealthy, когда лицензия отклонена, или IsExpired истинно; для платной лицензии это означает, что дата подписки прошла, и пакет, выпущенный после неё, будет отклонён — текущая сборка продолжает отрисовываться корректно. См. DoconutHost для значений статуса.

Обновления версии

Лицензия покрывает окно версии. Обновление пакета NuGet до сборки новее, чем это окно делает лицензию недействительной для этой сборки: IsVersionValid превращает false и открытие блокируется с помощью LicenseException (причина указана в License.RejectionMessage) — намеренно быстро завершать с ошибкой, чтобы устаревшая или нелицензированная сборка была обнаружена при развертывании, а не тихо водяным знаком помечала продуктивный вывод. Обновите подписку, замените .lic в wwwroot и перезапустите пул приложений, чтобы DoconutHost.Initialize загрузил новую лицензию.

Была ли эта страница полезной?