From 7b69405fc812a19d18dd6a4e2dee4893e2b4c3dd Mon Sep 17 00:00:00 2001
From: Liam Morland <liam@openplus.ca>
Date: Wed, 23 Nov 2022 08:50:44 -0500
Subject: [PATCH] Issue #3323376: Convert xfdf.inc to a class
---
src/Component/Utility/Xfdf.php | 76 +++++++++++++++++++++++
src/Plugin/PdfBackend/PdftkPdfBackend.php | 4 +-
tests/src/Kernel/XfdfKernelTest.php | 38 ++++++++++++
xfdf.inc | 51 ---------------
4 files changed, 116 insertions(+), 53 deletions(-)
create mode 100644 src/Component/Utility/Xfdf.php
create mode 100644 tests/src/Kernel/XfdfKernelTest.php
delete mode 100644 xfdf.inc
diff --git a/src/Component/Utility/Xfdf.php b/src/Component/Utility/Xfdf.php
new file mode 100644
index 0000000..81bea0d
--- /dev/null
+++ b/src/Component/Utility/Xfdf.php
@@ -0,0 +1,76 @@
+<?php
+
+namespace Drupal\fillpdf\Component\Utility;
+
+/**
+ * Provides functions for creating XFDF files.
+ *
+ * @package Drupal\fillpdf\Component\Utility
+ */
+class Xfdf {
+
+ /**
+ * Generates XFDF file object from values given in an associative array.
+ *
+ * @param array $info
+ * Key/value pairs of the field data.
+ * @param string|null $file
+ * The PDF file: URL or file path accepted. Use NULL to skip setting
+ * file-related properties.
+ * @param string $enc
+ * The character encoding. Must match server output: default_charset in
+ * php.ini.
+ *
+ * @return \DOMDocument
+ * A object representing the XFDF file contents.
+ */
+ public static function createDomDocument(array $info, string $file = NULL, string $enc = 'UTF-8'): \DOMDocument {
+ $doc = new \DOMDocument('1.0', $enc);
+
+ $xfdf_ele = $doc->appendChild($doc->createElement('xfdf'));
+ $xfdf_ele->setAttribute('xmlns', 'http://ns.adobe.com/xfdf/');
+ $xfdf_ele->setAttribute('xml:space', 'preserve');
+
+ $fields_ele = $xfdf_ele->appendChild($doc->createElement('fields'));
+ foreach ($info as $name => $value) {
+ $field_ele = $fields_ele->appendChild($doc->createElement('field'));
+ $field_ele->setAttribute('name', $name);
+
+ $value_ele = $field_ele->appendChild($doc->createElement('value'));
+ $value_ele->appendChild($doc->createTextNode($value ?: ''));
+ }
+
+ $ids_ele = $xfdf_ele->appendChild($doc->createElement('ids'));
+ if ($file) {
+ $ids_ele->setAttribute('original', md5($file));
+ }
+ $ids_ele->setAttribute('modified', \Drupal::time()->getRequestTime());
+
+ if ($file) {
+ $f_ele = $xfdf_ele->appendChild($doc->createElement('f'));
+ $f_ele->setAttribute('href', $file);
+ }
+
+ return $doc;
+ }
+
+ /**
+ * Generates XFDF file contents from values given in an associative array.
+ *
+ * @param array $info
+ * Key/value pairs of the field data.
+ * @param string|null $file
+ * The PDF file: URL or file path accepted. Use NULL to skip setting
+ * file-related properties.
+ * @param string $enc
+ * The character encoding. Must match server output: default_charset in
+ * php.ini.
+ *
+ * @return string
+ * The contents of the XFDF file.
+ */
+ public static function createString(array $info, string $file = NULL, string $enc = 'UTF-8'): string {
+ return static::createDomDocument($info, $file, $enc)->saveXML();
+ }
+
+}
diff --git a/src/Plugin/PdfBackend/PdftkPdfBackend.php b/src/Plugin/PdfBackend/PdftkPdfBackend.php
index a716d33..d8b648a 100644
--- a/src/Plugin/PdfBackend/PdftkPdfBackend.php
+++ b/src/Plugin/PdfBackend/PdftkPdfBackend.php
@@ -8,6 +8,7 @@ use Drupal\Core\File\FileSystemInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\file\FileInterface;
use Drupal\fillpdf\Component\Utility\FillPdf;
+use Drupal\fillpdf\Component\Utility\Xfdf;
use Drupal\fillpdf\FieldMapping\TextFieldMapping;
use Drupal\fillpdf\Plugin\PdfBackendBase;
use Drupal\fillpdf\ShellManager;
@@ -182,9 +183,8 @@ class PdftkPdfBackend extends PdfBackendBase implements ContainerFactoryPluginIn
}
}
- module_load_include('inc', 'fillpdf', 'xfdf');
$xfdf_name = $template_uri . '.xfdf';
- $xfdf = create_xfdf(basename($xfdf_name), $fields);
+ $xfdf = Xfdf::createString($fields, basename($xfdf_name));
// Generate the file.
$xfdf_file = \Drupal::service('file.repository')->writeData($xfdf, $xfdf_name, FileSystemInterface::EXISTS_RENAME);
diff --git a/tests/src/Kernel/XfdfKernelTest.php b/tests/src/Kernel/XfdfKernelTest.php
new file mode 100644
index 0000000..f098806
--- /dev/null
+++ b/tests/src/Kernel/XfdfKernelTest.php
@@ -0,0 +1,38 @@
+<?php
+
+namespace Drupal\Tests\fillpdf\Kernel;
+
+use Drupal\fillpdf\Component\Utility\Xfdf;
+use Drupal\KernelTests\KernelTestBase;
+
+/**
+ * Test the XfdfUnitTest class.
+ *
+ * @group fillpdf
+ * @covers \Drupal\fillpdf\Component\Utility\Xfdf
+ */
+class XfdfKernelTest extends KernelTestBase {
+
+ /**
+ * Test Xfdf.
+ */
+ public function test() {
+ // Random input values.
+ $key = $this->randomMachineName();
+ $value = $this->randomString() . '"';
+ $fields = [
+ $key => $value,
+ ];
+
+ $expected = '<?xml version="1.0" encoding="UTF-8"?>
+<xfdf xmlns="http://ns.adobe.com/xfdf/" xml:space="preserve"><fields><field name="' . $key . '"><value>' . htmlspecialchars($value, ENT_NOQUOTES) . '</value></field></fields><ids modified="1234"/></xfdf>
+';
+
+ $actual = Xfdf::createString($fields);
+ // Make the timestamp always be the same.
+ $actual = preg_replace('/ modified="\d+"/', ' modified="1234"', $actual);
+
+ $this->assertSame($expected, $actual);
+ }
+
+}
diff --git a/xfdf.inc b/xfdf.inc
deleted file mode 100644
index 9f0a620..0000000
--- a/xfdf.inc
+++ /dev/null
@@ -1,51 +0,0 @@
-<?php
-
-/**
- * @file
- * Provides functions for creating XFDF files.
- */
-
-/**
- * Generates an XFDF file from values given in an associative array.
- *
- * @param string|null $file
- * The PDF file: URL or file path accepted. Use NULL to skip setting
- * file-related properties.
- * @param array $info
- * Key/value pairs of the field data.
- * @param string $enc
- * The character encoding. Must match server output: default_charset in
- * php.ini.
- *
- * @return string
- * The contents of the XFDF file.
- */
-function create_xfdf($file, array $info, $enc = 'UTF-8') {
- $doc = new DOMDocument('1.0', $enc);
-
- $xfdf_ele = $doc->appendChild($doc->createElement('xfdf'));
- $xfdf_ele->setAttribute('xmlns', 'http://ns.adobe.com/xfdf/');
- $xfdf_ele->setAttribute('xml:space', 'preserve');
-
- $fields_ele = $xfdf_ele->appendChild($doc->createElement('fields'));
- foreach ($info as $name => $value) {
- $field_ele = $fields_ele->appendChild($doc->createElement('field'));
- $field_ele->setAttribute('name', $name);
-
- $value_ele = $field_ele->appendChild($doc->createElement('value'));
- $value_ele->appendChild($doc->createTextNode($value ?: ''));
- }
-
- $ids_ele = $xfdf_ele->appendChild($doc->createElement('ids'));
- if ($file) {
- $ids_ele->setAttribute('original', md5($file));
- }
- $ids_ele->setAttribute('modified', \Drupal::time()->getRequestTime());
-
- if ($file) {
- $f_ele = $xfdf_ele->appendChild($doc->createElement('f'));
- $f_ele->setAttribute('href', $file);
- }
-
- return $doc->saveXML();
-}
--
GitLab