Асинхронный режим передачи по ICAP

В асинхронном режиме mp-collector принимает файл, передает его в обработку и сразу отвечает клиенту, не дожидаясь завершения проверки.

После успешной передачи файла в обработку сервер возвращает 200 OK с заголовком X-Request-IDs. Заголовок содержит идентификаторы файлов, переданных на проверку. Несколько идентификаторов разделяются точкой с запятой (;).

Для обычного файла:

X-Request-IDs: 123456

Для файлов из распакованного архива:

X-Request-IDs: 123456;123457;123458

Каждый RequestID относится к отдельному файлу. Если файл проверяется по нескольким цепочкам, во всех цепочках используется один и тот же RequestID. Конкретная проверка определяется сочетанием RequestID и ChainID.

Обработка архивов

При включенной распаковке архивов RequestID назначается только тем объектам, которые непосредственно передаются на проверку.

Пример назначения RequestID файлам из архива
archive.zip
├── document.pdf → RequestID 123
├── image.jpg   → RequestID 124
└── nested.zip
    └── document2.docx → RequestID 125

Если распаковка отключена или достигнута максимальная глубина распаковки, архив проверяется как обычный файл и получает собственный RequestID.

Получение состояния проверки файла

Состояние асинхронной проверки можно запросить по адресу:

GET /back/mp-core/filecheck/status/{request_id}/{chain_id}
  • request_id — идентификатор файла из заголовка X-Request-IDs

  • chain_id — идентификатор цепочки.

Пример:

GET /back/mp-core/filecheck/status/10116893563554923573/ddaaef90-fc0e-446b-8713-3a786a25c423

Если один файл был отправлен по нескольким цепочкам, его состояние запрашивается отдельно для каждой цепочки с использованием одного и того же RequestID.

Проверка еще выполняется

Если файл найден среди активных проверок, возвращается состояние:

{
  "status": "in_process"
}

Проверка завершена

Если проверка завершена, сервер возвращает состояние finished и сформированный отчёт в поле report:

{
  "status": "finished",
  "report": {
    "...": "..."
  }
}

Проверка не найдена

Если сочетание RequestID и ChainID не найдено ни среди выполняющихся, ни среди завершённых проверок, сервер возвращает ошибку:

{
  "error": {
    "code": 0,
    "msg": "file check not found"
  }
}

Нюансы

Если атрибут filename заголовка Content-Disposition задан в форме RFC 2231 (filename*=), поддерживаются кодировки UTF-8 и US-ASCII. В соответствии с RFC 8187 другие кодировки не допускаются.

Хотя RFC 7578 объявляет заголовок Content-Transfer-Encoding устаревшим для отдельных частей multipart/form-data, Система поддерживает кодирование base64 и quoted-printable. Подробнее см. раздел Расшифровки файлов base64.