Как работает Viewer

Doconut рендерит документы в виде постраничных изображений, обслуживаемых через middleware ASP.NET Core. Понимание жизненного цикла — открытие, токен, запросы страниц, закрытие — объясняет почти все наблюдаемые поведения, включая сообщения об ошибках.

Три движущих компонента

• Viewer — публичный сервис, который вы внедряете. Он открывает документы и возвращает токены сессий.
• Сессия документа — объект на стороне сервера, хранящий загруженный документ, индексируемый токеном в IMemoryCache.
• Middleware Doconut — добавляется через UseDoconut(); отвечает на каждый запрос, который делает виджет браузера (pages, thumbnails, search, annotations, …), всегда аутентифицированный токеном.

Viewer без состояния — по замыслу

Viewer закрыт (sealed), не хранит состояние документа на каждый запрос и сознательно не реализует IDisposable. Сессии живут независимо в менеджере сессий и очищаются по истечении срока кэша или при явном вызове CloseDocument(token).

Внедрите его там, где он нужен:

app.MapPost("/api/open", async (string fileName, Viewer viewer) =>
{
    var token = await viewer.OpenDocumentAsync($"files/{fileName}");
    return Results.Content(token, "text/plain");
});

Что происходит внутри OpenDocumentAsync

1. Проверка лицензии. Отклонённая или просроченная версия лицензии (в чёрном списке, подделана, или сборка вне окна обновления лицензии) сразу бросает LicenseException с причиной отклонения в сообщении — открытие никогда не деградирует тихо при недействительной (в отличие от отсутствующей) лицензии. Исключение составляет календарно просроченная временная или подписочная лицензия: она не бросает исключение — переходит в режим водяного знака.
2. Создание сессии. Фабрика viewer выбирает подходящий просмотрщик формата по расширению файла и загружает документ (см. Rendering Pipeline). Сессия сохраняется в IMemoryCache под новым GUID‑токеном с скользящим истечением — DocOptions.TimeOut минут, по умолчанию 60. Каждый запрос страницы сбрасывает таймер.
3. Регистрация безопасности. При UnsafeMode = false (по умолчанию) токен привязывается к ASP.NET‑сессии вызывающего: в сессию записывается маркер secure-{token}, поэтому только та браузерная сессия, которая открыла документ, может запрашивать его страницы.
4. Токен возвращается. Он является единственным учётным данным для всего последующего.

Три перегрузки отличаются лишь входными данными: путь к файлу, путь к файлу плюс конфигурация конкретного формата (PdfConfig, WordConfig, …) или Stream плюс FileInfo, расширение которого определяет формат.

Как виджет получает страницы

Виджет клиента вызывает middleware Doconut, передавая токен в строке запроса. Действия middleware зависят от запроса:

Каждый из этих путей сначала проходит проверку:

• Отсутствует токен → middleware возвращает 404 (или баннер версии, когда ShowDoconutInfo = true).
• Неизвестный или просроченный токен → изображение ошибки с текстом Document session not found. Please re-open document.
• Отсутствует middleware сессии (при UnsafeMode = false) → HTTP 500 с сообщением Session middleware not configured. Call UseSession() before UseDoconut().
• Токен открыт в другой браузерной сессии → изображение ошибки с текстом You Are Not Authorized To View This Page.

Закрытие документа

viewer.CloseDocument(token);

CloseDocument удаляет сессию из кэша (что освобождает движок документа и сразу освобождает память), удаляет маркер secure-{token} и отзывает право доступа. Вызывать её необязательно — скользящее истечение автоматически делает то же самое — но для больших документов это вежливый способ освободить память сразу после завершения работы пользователя.

Основные выводы

• Один открытый документ = одна сессия = один токен. Токены привязаны к браузерной сессии, а не к глобальным URL.
• Токен истекает по скользящему окну; если viewer простаивает дольше DocOptions.TimeOut, требуется повторное открытие.
• Viewer можно внедрять и свободно делиться; сессии несут всё состояние.