Пустое поле Comments на XFA-форме заявки переоткрывается с одним переводом строки внутри. Сохраните и переоткройте ещё раз — в поле уже два. Имя клиента, набранное с U+1F642, слегка улыбающимся лицом, возвращается как U+F642 — кодовая точка из private use area, которую большинство шрифтов рисует пустым прямоугольником. Все три эффекта живут в XML, который XFA save пишет в пакет datasets, и save-путь, делающий это правильно, обязан не пускать форматировочный пробел в значения полей, нести символы дополнительной плоскости целыми суррогатными парами и сообщать о неудавшейся записи через результат save, а не через повреждённый файл
Какой runtime PDFium сохраняет значения XFA?
Значения XFA сохраняет только pdfium.v8.dll, потому что лишь эта сборка PDFium Component несёт и V8-движок JavaScript, и рантайм XFA-форм. Когда правка закоммичена (поле потеряло фокус, или коммит форсировал ClearFormFieldFocus), этот рантайм при сохранении экспортирует живые данные XFA в пакет datasets — без правки пакетов в вашем коде. Для каждой архитектуры Windows поставляется и обычный pdfium.dll, собранный без V8 и XFA, который записывает хранимые пакеты назад в точности так, как прочитал. Что случается со значением, записанным, пока поле ещё в фокусе, разобрано в статье о том, почему правки XFA-полей исчезают при save
Обёртка Delphi пытается подобрать библиотеку за вас. Пока EnableV8Engine равен False и ни одна библиотека PDFium ещё не загружена, TPdf смотрит на файл, который собирается открыть, и, найдя маркеры XFA (запись /XFA в словаре AcroForm или /NeedsRendering true в каталоге), включает EnableV8Engine перед загрузкой. Этот переключатель работает один раз за процесс. Если обычный pdfium.dll уже resident, потому что первым документом сеанса был обычный PDF, процесс остаётся привязан к нему, и при приходе XFA-документа позже срабатывает TPdf.OnXfaRuntimeMissing
Порядок поиска по умолчанию — вторая половина проблемы. Без каталога в LibraryName загрузчик начинает с папки DLLs\Win32 или DLLs\Win64 под папкой приложения или одним из её родителей, поэтому первым может найтись более старый pdfium.v8.dll. LibraryName с каталогом внутри закрепляет ровно этот файл, а если его нет — загрузка отказывает
uses
System.SysUtils, PDFium;
procedure SelectXfaRuntime;
begin
// Каталог в LibraryName закрепляет ровно этот файл;
// отсутствующий файл заставит LoadLibrary отказать вместо поиска в других местах
{$IFDEF WIN64}
PDFium.LibraryName := ExtractFilePath(ParamStr(0)) + 'DLLs\Win64\pdfium.v8.dll';
{$ELSE}
PDFium.LibraryName := ExtractFilePath(ParamStr(0)) + 'DLLs\Win32\pdfium.v8.dll';
{$ENDIF}
PDFium.EnableV8Engine := True;
PDFium.LoadLibrary; // отказываемся на старте, а не при первом XFA save
end;
После открытия документа TPdf.XFA сообщает, что файл содержит XFA, а TPdf.XfaRuntimeAvailable — что загруженная библиотека способна реально запустить XFA-движок для этого документа. Статические и динамические формы различаются через TPdf.FormType, который возвращает ftXfaFull для динамической формы и ftXfaForeground для статической. Зондирование на уровне пакетов на машине без V8-рантайма — тема статьи об обнаружении XFA-форм и извлечении XFA-пакетов в Delphi
Почему сохранённые XFA-поля обрастают лишними переводами строк?
Сохранённые XFA-поля обрастают переводами строк, когда писатель красиво форматирует XML, ставя перевод строки после каждого открывающего тега. В XFA save участвуют два писателя — общий писатель XML-элементов и сериализатор form-пакета, и оба привычно форматируют вывод именно так. В большинстве XML-документов этот пробел — косметика. В данных XFA это значение: когда пакет datasets разбирается снова, каждый символ между <Comments> и </Comments>, перевод строки включительно, принадлежит полю
Поэтому пустое поле переоткрывается с одним LF внутри. Каждое следующее сохранение форматирует вокруг уже имеющегося LF, так что поле, которого никто не касался, растёт на одну строку за круг согласования
Обрезать значения при загрузке выглядит дешёвым ремонтом, и это попортило бы настоящие данные. Люди вводят в XFA-поля ведущие пробелы, хвостовые пробелы и нарочитые переводы строк; блок адреса обязан сохранить структуру строк, а код фиксированной ширины — выжить байт в байт. Поэтому XFA-писатели в PDFium Component убирают только пробел, который сериализатор сам синтезирует вокруг тегов. Пользовательские значения, текстовые узлы, уже бывшие в файле, и секции CDATA проходят нетронутыми, так что " indented" остаётся с отступом, а нарочно пустое поле остаётся пустым
Emoji, суррогатные пары и 16-битный wchar_t
Emoji возвращается другим символом, когда путь декодирования кладёт полное скалярное значение Unicode в одиночный wchar_t, который на Windows 16-битный. В XFA-загрузке этому подвержены два места: декодер потока UTF-8 и парсер числовых символьных ссылок вроде 🙂. U+1F642 нужно 17 бит. Втисните его в 16 — старший бит отваливается, оставляя U+F642 в Private Use Area
Сериализатор формы может ошибиться в обратную сторону. Фильтруя символы по одному wchar_t, он видит две суррогатные кодовые единицы, D83D и DE42, каждая из которых поодиночке недопустима, и выбрасывает обе. Emoji исчезает из form-пакета, не оставив после себя символа-заменителя
В PDFium Component декодер съедает каждое скалярное значение целиком и выдаёт правильную суррогатную пару — в том числе когда в выходном буфере остаётся место лишь на одну единицу и когда четырёхбайтовая последовательность UTF-8 разрезана между двумя блоками чтения. На выходе экспортёр формы держит валидные суррогатные пары вместе, а числовые символьные ссылки декодируются в корректные пары
Тестовые данные из Latin-1 не касаются ни одного из этих путей. Round-trip тесту XFA-формы нужен хотя бы один символ выше U+FFFF в текстовом поле, и проверить сохранённые байты на четырёхбайтовую последовательность UTF-8 F0 9F 99 82 показательнее, чем смотреть на отрисованное поле
Single-stream XFA и результат save
Single-stream XFA-документ сохраняет правки, только если save-путь может переписать один XDP-поток на месте, а любой вход, который он переписать не может, обязан валить save. ISO 32000-1 §12.7.8 дозволяет записи /XFA словаря интерактивной формы быть либо массивом, чередующим имена пакетов и потоки, либо единственным потоком, держащим весь XDP-документ. Save-путь, написанный только под массивы, отвергает одиночные потоки, и если звонящий игнорирует этот результат, PDF записывается с данными формы на старых значениях
V8-рантайм в PDFium Component обрабатывает определённое подмножество single-stream в три шага. Он экспортирует оба живых пакета, datasets и form, в область подготовки и валидирует их. И лишь затем подменяет совпадающие пакеты внутри исходного XDP, сохраняя прочие пакеты и объявления корневых пространств имён. Если подготовка сорвалась, персистентный XFA-поток не трогается вовсе, и документ хранит отметку модификации, так что последующий save может попытаться снова
XML-комментариям и инструкциям обработки нужен особый уход, потому что парсер, используемый для перезаписи, их выбрасывает. Каждый из них перед разбором подменяется уникальным маркером и возвращается после, а поток записывается, только если каждый маркер встретился ровно один раз, — комментарии вне живых пакетов сохраняют свой текст и порядок
Некоторые входы отвергаются сразу и полностью, и каждый отказ доходит до вас как проваленный save:
- Комментарии или инструкции обработки внутри живых пакетов
datasetsилиform— их исходные позиции невозможно отобразить в свежеэкспортированное содержимое - Объявления DTD и подписи XMLDSig — переписывание XDP не способно сохранить подпись XML валидной
- Некорректная кодировка UTF-8 или UTF-16, незакрытые теги, неверные символьные ссылки, неизвестные сущности и битые инструкции обработки — отвергаются вместо починки на лету
Отказ — лучшая сделка здесь. Save, вернувший False, можно повторить, залогировать или отдать человеку, тогда как XDP, тихо нормализованный, может сломать подпись или нижестоящий импортёр неделями позже, далеко от кода, который его изменил. Что single-stream путь всё же сохраняет — содержательную модель XML, записанную как UTF-8; исходная байтовая раскладка и объявление кодировки исходного потока не переносятся
Последний буферизованный блок
Последняя ловушка сидит ниже XFA, в общем PDF-писателе. Файловый писатель, буферизующий вывод блоками фиксированного размера, обязан вытолкнуть последний неполный блок в конце. Если это происходит в коде очистки после того, как писатель документа уже отрапортовал успех, переполнение диска или I/O-ошибка на последнем блоке никогда не дойдут до звонящего, и файл на диске окажется коротким. В обоих рантаймах PDFium Component финальный сброс — часть результата save, и отметка модификации XFA снимается только после того, как запись действительно удалась
Сторона Delphi добавляет ещё один слой. TPdf.SaveAs пишет во временный файл рядом с целью и подвигает его на место цели, только когда сохранение потока вернёт True. Результат False оставляет прежний файл ровно как был, а провал финальной подмены поднимает ошибку ОС вместо тихого возврата
Почему динамическая XFA-форма переоткрывается с меньшим числом страниц?
Динамическая XFA-форма переоткрывается с меньшим числом страниц, когда её корневой subform не объявляет restoreState="auto", и это решение принадлежит автору формы. В XFA 3.3 restoreState на корневом subform по умолчанию равен manual. Под manual XFA-процессор восстанавливает из сохранённого form-пакета лишь ограниченное состояние, а остальное оставляет собственным скриптам формы. Значения полей и счётчики инстансов повторяющихся subform возвращаются; геометрические свойства, выставленные в рантайме, — нет
Возьмите трёхстраничную форму, чей скрипт выращивает subform до h="450pt", пока пользователь её заполняет. Сохранённый form-пакет держит новую высоту, значения полей и счётчики инстансов. При переоткрытии раскладка пересобирается по шаблонным высотам, subform сжимается обратно, и содержимое перетекает на две страницы. Это то поведение, которого требует спецификация XFA, когда шаблон никогда не просил автоматического восстановления. Объявить его на корневом subform — и переоткрытие меняется:
<template xmlns="http://www.xfa.org/schema/xfa-template/3.3/">
<subform name="form1" layout="tb" restoreState="auto">
<pageSet>
<pageArea name="Page1">
<contentArea x="0.25in" y="0.25in" w="8in" h="10.5in"/>
<medium stock="letter"/>
</pageArea>
</pageSet>
<subform name="Details" layout="tb" w="7.5in">
<!-- поля; скрипты могут менять h или добавлять инстансы в рантайме -->
</subform>
</subform>
</template>
Если шаблон не ваш — не трогайте его: форма, построенная под режим manual, ждёт, что состояние пересоберут её собственные скрипты инициализации, и смена режима у них под ногами меняет то, вокруг чего эти скрипты писались. Живая репагинация во время набора — другой механизм, описанный в статье о том, как PDFium Component следит за числом страниц dynamic XFA и переехавшими полями
Проверка XFA round trip из Delphi
XFA save проверяется переоткрытием сохранённого файла в свежем инстансе TPdf и чтением сохранённых данных назад, потому что True от SaveAs говорит лишь о том, что файл был записан. TPdf.GetXfaDatasets возвращает пакет datasets так, как он хранится в документе, а не живую модель данных, поэтому чтение до сохранения показывает значения прошлой загрузки. После переоткрытия он показывает ровно то, что было записано. У single-stream документа нет отдельно именованных пакетов: PDFium рапортует весь XDP одним пакетом с пустым именем, так что и GetXfaPacketByName('datasets'), и GetXfaDatasets возвращают пустой массив, и код ниже откатывается к полному потоку из GetXfaFormPackets
uses
System.SysUtils, PDFium, FPdfXfa;
function ReadSavedXfaData(const FileName: string): string;
var
Pdf: TPdf;
Packets: TXfaPacketList;
Bytes: TBytes;
begin
Pdf := TPdf.Create(nil);
try
Pdf.FileName := FileName;
Pdf.Active := True;
Bytes := Pdf.GetXfaDatasets; // раскладка с массивом пакетов
if Length(Bytes) = 0 then
begin
Packets := Pdf.GetXfaFormPackets; // одиночный поток: один безымянный пакет
if Length(Packets) = 1 then
begin
SetLength(Bytes, Length(Packets[0].Content));
if Length(Bytes) > 0 then
Move(Packets[0].Content[0], Bytes[0], Length(Bytes));
end;
end;
Result := TEncoding.UTF8.GetString(Bytes); // сохранённый вывод XDP — UTF-8
finally
Pdf.Free;
end;
end;
Save-подпрограмма коммитит отложенную правку, проверяет результат SaveAs и сравнивает переоткрытое значение. TPdf.ClearFormFieldFocus снимает фокус формы — тот момент, когда PDFium коммитит буфер правки сфокусированного поля. TPdf.SetFocusedFormFieldText может заполнить сфокусированное поле из кода, но опирается на фокус, отслеживаемый через аннотации widget, которых у динамической XFA-страницы обычно нет; там функция возвращает False, и текст обычно приходит клавиатурным вводом в TPdfView
// XmlText — хелпер, который вы добавляете сами; это не часть PDFium Component
function XmlText(const S: string): string;
begin
Result := StringReplace(S, '&', '&', [rfReplaceAll]);
Result := StringReplace(Result, '<', '<', [rfReplaceAll]);
end;
procedure SaveXfaAndVerify(Pdf: TPdf; const FileName, FieldTag,
Expected: string);
var
Saved: string;
begin
// Опциональное заполнение скриптом; False = ни одно отслеживаемое поле не в фокусе
if (Pdf.FocusedFormFieldIndex >= 0) and
not Pdf.SetFocusedFormFieldText(Expected) then
raise EPdfError.Create('Could not write the focused field');
Pdf.ClearFormFieldFocus; // коммитим буфер правки
if not Pdf.SaveAs(FileName) then // False: прежний файл остаётся на месте
raise EPdfError.CreateFmt('Saving %s failed', [FileName]);
// Переоткрываем в свежем TPdf и ищем точный текст элемента
Saved := ReadSavedXfaData(FileName);
if Pos('<' + FieldTag + '>' + XmlText(Expected) + '</' + FieldTag + '>',
Saved) = 0 then
raise EPdfError.CreateFmt('%s did not survive the round trip', [FieldTag]);
end;
Substring-тест — лишь дымовая проверка. Пустой элемент может быть записан как <Tag/>, элементы данных могут нести атрибуты, а экранирование за пределами & и < — выбор сериализатора, поэтому продовые проверки принадлежат настоящему XML-парсеру. Прогоните подпрограмму дважды подряд на одном входе: уплывание переводов строк показывает полную форму лишь во втором поколении
Хост-приложения, водящие XFA-рантайм напрямую, также нуждаются в раскладке колбэков, которую он ждёт, — это тема статьи FPDF_FORMFILLINFO version 2 и ABI XFA в Delphi. Оба Windows-рантайма для Win32 и Win64, обёртка Delphi и C++Builder и контрол вьюера TPdfView входят в PDFium Component for Delphi and C++Builder