From f92fc8b4e33bcc8b6a44c05b164de7cf9796767c Mon Sep 17 00:00:00 2001
From: Kevin Kaland <kevin@wizonesolutions.com>
Date: Sat, 8 Nov 2014 17:57:22 +0100
Subject: [PATCH] Almost add support for parsing.
There's lots of changes here. I should have committed more often.
Anyway, the gist of it is:
- General code conversion to Drupal 8 patterns. I've taken shortcuts here and there but mostly avoid that. No idea on the quality. Hopefully, someone can give me some feedback.
- Two new entity types, FillPdfForm and FillPdfFormField. These
correspond to the old {fillpdf_forms} and {fillpdf_fields}
tables. Now they're finally entities, so Views support will
be possible for those of you who wanted it. I was finally forced to
do this, and I'm glad.
- PDF-filling methods are now PLUGINS!!! This means they all
implement FillPdfBackendPluginInterface, and this basically
achieves the same thing I was trying to do with the failed
pdf_forms project. Anyone who wants to add their own
backend can already do it; the fillpdf_service_backend
configuration variable is used to select the correct backend.
It should match the annotation ID. Look at
FillPdfServiceFillPdfBackend to get an idea of how to structure the
plugin.
- Better use of actual entity references. FillPdfForms store a
reference to their underlying Files instead of just an ID. Same with
FillPdfFormField -> FillPdfForm.
---
.gitignore | 2 +
config/install/fillpdf.settings.yml | 3 +
fillpdf.admin.inc | 128 +++---
fillpdf.info.yml | 2 +
fillpdf.install | 368 +++++++++---------
fillpdf.links.menu.yml | 8 +-
fillpdf.module | 27 +-
fillpdf.routing.yml | 14 +-
fillpdf.services.yml | 4 +
src/Entity/FillPdfForm.php | 72 ++++
src/Entity/FillPdfFormField.php | 84 ++++
src/FillPdfBackendManager.php | 37 ++
src/FillPdfBackendManagerInterface.php | 12 +
src/FillPdfBackendPluginInterface.php | 46 +++
src/FillPdfFormFieldInterface.php | 13 +
src/FillPdfFormInterface.php | 16 +
src/Form/FillPdfAdminFormBase.php | 24 ++
src/Form/FillPdfOverviewForm.php | 231 +++++++++++
src/Form/FillpdfSettingsForm.php | 22 +-
.../FillPdfServiceFillPdfBackend.php | 121 ++++++
20 files changed, 942 insertions(+), 292 deletions(-)
create mode 100644 .gitignore
create mode 100644 fillpdf.services.yml
create mode 100644 src/Entity/FillPdfForm.php
create mode 100644 src/Entity/FillPdfFormField.php
create mode 100644 src/FillPdfBackendManager.php
create mode 100644 src/FillPdfBackendManagerInterface.php
create mode 100644 src/FillPdfBackendPluginInterface.php
create mode 100644 src/FillPdfFormFieldInterface.php
create mode 100644 src/FillPdfFormInterface.php
create mode 100644 src/Form/FillPdfAdminFormBase.php
create mode 100644 src/Form/FillPdfOverviewForm.php
create mode 100644 src/Plugin/FillPdfBackend/FillPdfServiceFillPdfBackend.php
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..90c6337
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+# REMOVE ONCE FULLY PORTED.
+/upgrade-info.html
diff --git a/config/install/fillpdf.settings.yml b/config/install/fillpdf.settings.yml
index 99356e0..fb27708 100644
--- a/config/install/fillpdf.settings.yml
+++ b/config/install/fillpdf.settings.yml
@@ -1 +1,4 @@
fillpdf_remote_protocol: https
+
+# Should not contain a protocol. That's what the above is for.
+fillpdf_remote_endpoint: fillpdf-service.com/xmlrpc.php
\ No newline at end of file
diff --git a/fillpdf.admin.inc b/fillpdf.admin.inc
index e65dbf4..49d3d61 100644
--- a/fillpdf.admin.inc
+++ b/fillpdf.admin.inc
@@ -5,75 +5,65 @@
* Allows mappings of PDFs to site content
*/
-define('FILLPDF_REPLACEMENTS_DESCRIPTION', t("<p>Tokens, such as those from CCK, sometimes output values that need additional
- processing prior to being sent to the PDF. A common example is when a key within a CCK <em>Allowed values</em>
- configuration does not match the field name or option value in the PDF that you would like to be selected but you
- do not want to change the <em>Allowed values</em> key.</p><p>This field will replace any matching values with the
- replacements you specify. Specify <strong>one replacement per line</strong> in the format
- <em>original value|replacement value</em>. For example, <em>yes|Y</em> will fill the PDF with
- <strong><em>Y</em></strong> anywhere that <strong><em>yes</em></strong> would have originally
- been used. <p>Note that omitting the <em>replacement value</em> will replace <em>original value</em>
- with a blank, essentially erasing it.</p>"));
-
-/* ---------------- Form Create --------------------*/
-/**
- * Manage your existing forms, or upload a new one
- */
-function fillpdf_forms_admin($form, &$form_state) {
- $result = db_query("SELECT admin_title, title, url, fid FROM {fillpdf_forms} ORDER BY admin_title");
- $header = array(
- t('Administrative title'),
- t('Title'),
- t('Location'),
- array(
- 'data' => t('Operations'),
- 'colspan' => '4',
- ),
- );
- $rows = array();
- foreach ($result as $pdf_form) {
- $row = array(
- check_plain($pdf_form->admin_title),
- check_plain($pdf_form->title),
- check_plain($pdf_form->url),
- l(t('Edit'), "admin/structure/fillpdf/$pdf_form->fid"),
- l(t('Delete'), "admin/structure/fillpdf/$pdf_form->fid/delete"),
- l(t('Export field mappings'), "admin/structure/fillpdf/$pdf_form->fid/export"),
- l(t('Import field mappings'), "admin/structure/fillpdf/$pdf_form->fid/import"),
- );
- $rows[] = $row;
- }
- if (!$rows) {
- $rows[] = array(array('data' => t('No content available.'), 'colspan' => 7));
- }
-
- $form['existing_forms'] = array(
- '#markup' => theme('table', array('header' => $header, 'rows' => $rows, 'attributes' => array('id' => 'fillpdf'))),
- );
-
- // Only show PDF upload form if fillpdf is configured.
- if (variable_get('fillpdf_service')) {
- $form['#attributes'] = array('enctype' => "multipart/form-data");
- $form['upload_pdf'] = array(
- '#type' => 'file',
- '#title' => 'Upload',
- '#description' => 'Upload a PDF template to create a new form',
- );
- $form['submit'] = array(
- '#type' => 'submit',
- '#value' => t('Upload'),
- '#weight' => 15,
- );
- }
- else {
- $form['message'] = array(
- '#markup' => '<p>' . t('Before you can upload PDF files, you must !link.', array('!link' => l(t('configure FillPDF'), 'admin/config/media/fillpdf'))) . '</p>',
- );
- drupal_set_message(t('FillPDF is not configured.'), 'error');
- }
-
- return $form;
-}
+///* ---------------- Form Create --------------------*/
+///**
+// * Manage your existing forms, or upload a new one
+// */
+//function fillpdf_forms_admin($form, &$form_state) {
+// $result = db_query("SELECT admin_title, title, url, fid FROM {fillpdf_forms} ORDER BY admin_title");
+// $header = array(
+// t('Administrative title'),
+// t('Title'),
+// t('Location'),
+// array(
+// 'data' => t('Operations'),
+// 'colspan' => '4',
+// ),
+// );
+// $rows = array();
+// foreach ($result as $pdf_form) {
+// $row = array(
+// check_plain($pdf_form->admin_title),
+// check_plain($pdf_form->title),
+// check_plain($pdf_form->url),
+// l(t('Edit'), "admin/structure/fillpdf/$pdf_form->fid"),
+// l(t('Delete'), "admin/structure/fillpdf/$pdf_form->fid/delete"),
+// l(t('Export field mappings'), "admin/structure/fillpdf/$pdf_form->fid/export"),
+// l(t('Import field mappings'), "admin/structure/fillpdf/$pdf_form->fid/import"),
+// );
+// $rows[] = $row;
+// }
+// if (!$rows) {
+// $rows[] = array(array('data' => t('No content available.'), 'colspan' => 7));
+// }
+//
+// $form['existing_forms'] = array(
+// '#markup' => theme('table', array('header' => $header, 'rows' => $rows, 'attributes' => array('id' => 'fillpdf'))),
+// );
+//
+// // Only show PDF upload form if fillpdf is configured.
+// if (variable_get('fillpdf_service')) {
+// $form['#attributes'] = array('enctype' => "multipart/form-data");
+// $form['upload_pdf'] = array(
+// '#type' => 'file',
+// '#title' => 'Upload',
+// '#description' => 'Upload a PDF template to create a new form',
+// );
+// $form['submit'] = array(
+// '#type' => 'submit',
+// '#value' => t('Upload'),
+// '#weight' => 15,
+// );
+// }
+// else {
+// $form['message'] = array(
+// '#markup' => '<p>' . t('Before you can upload PDF files, you must !link.', array('!link' => l(t('configure FillPDF'), 'admin/config/media/fillpdf'))) . '</p>',
+// );
+// drupal_set_message(t('FillPDF is not configured.'), 'error');
+// }
+//
+// return $form;
+//}
/**
* Makes sure the Upload was provided (want to validate .pdf here too)
diff --git a/fillpdf.info.yml b/fillpdf.info.yml
index e6e59ed..81ab701 100644
--- a/fillpdf.info.yml
+++ b/fillpdf.info.yml
@@ -5,4 +5,6 @@ core: 8.x
package: Other
version: VERSION
dependencies:
+ - file
+ - link
- token
diff --git a/fillpdf.install b/fillpdf.install
index 92e4f68..f9e0b3c 100644
--- a/fillpdf.install
+++ b/fillpdf.install
@@ -11,198 +11,184 @@
function fillpdf_schema() {
$schema = array();
- $schema['fillpdf_forms'] = array(
- 'fields' => array(
- 'fid' => array(
- 'type' => 'int',
- 'unsigned' => TRUE,
- 'not null' => TRUE,
- ),
- 'title' => array(
- 'type' => 'varchar',
- 'length' => 512,
- 'not null' => TRUE,
- ),
- 'default_nid' => array(
- 'type' => 'int',
- 'unsigned' => TRUE,
- 'not null' => FALSE,
- ),
- 'url' => array(
- 'type' => 'varchar',
- 'length' => 255,
- 'not null' => TRUE,
- ),
- 'destination_path' => array(
- 'type' => 'varchar',
- 'length' => 255,
- 'not null' => FALSE
- ),
- 'replacements' => array(
- 'type' => 'text',
- 'size' => 'normal',
- 'not null' => FALSE
- ),
- 'destination_redirect' => array(
- 'type' => 'int',
- 'unsigned' => TRUE,
- 'not null' => FALSE,
- ),
- 'admin_title' => array(
- 'type' => 'varchar',
- 'length' => 512,
- 'not null' => FALSE,
- ),
- ),
- 'primary key' => array('fid'),
- );
-
- $schema['fillpdf_fields'] = array(
- 'fields' => array(
- 'fid' => array(
- 'type' => 'int',
- 'unsigned' => TRUE,
- 'not null' => TRUE,
- ),
- 'pdf_key' => array(
- 'type' => 'varchar',
- 'length' => 255,
- 'not null' => TRUE,
- ),
- 'label' => array(
- 'type' => 'varchar',
- 'length' => 255,
- 'not null' => TRUE,
- ),
- 'prefix' => array(
- 'type' => 'varchar',
- 'length' => 4096,
- 'not null' => FALSE,
- ),
- 'value' => array(
- 'type' => 'text',
- 'size' => 'medium',
- 'not null' => TRUE,
- ),
- 'suffix' => array(
- 'type' => 'varchar',
- 'length' => 4096,
- 'not null' => FALSE,
- ),
- 'replacements' => array(
- 'type' => 'text',
- 'size' => 'normal',
- 'not null' => FALSE,
- ),
- ),
- 'primary key' => array('fid', 'pdf_key'),
- );
+// $schema['fillpdf_forms'] = array(
+// 'fields' => array(
+// 'fid' => array(
+// 'type' => 'int',
+// 'unsigned' => TRUE,
+// 'not null' => TRUE,
+// ),
+// 'title' => array(
+// 'type' => 'varchar',
+// 'length' => 512,
+// 'not null' => TRUE,
+// ),
+// 'default_nid' => array(
+// 'type' => 'int',
+// 'unsigned' => TRUE,
+// 'not null' => FALSE,
+// ),
+// 'url' => array(
+// 'type' => 'varchar',
+// 'length' => 255,
+// 'not null' => TRUE,
+// ),
+// 'destination_path' => array(
+// 'type' => 'varchar',
+// 'length' => 255,
+// 'not null' => FALSE
+// ),
+// 'replacements' => array(
+// 'type' => 'text',
+// 'size' => 'normal',
+// 'not null' => FALSE
+// ),
+// 'destination_redirect' => array(
+// 'type' => 'int',
+// 'unsigned' => TRUE,
+// 'not null' => FALSE,
+// ),
+// 'admin_title' => array(
+// 'type' => 'varchar',
+// 'length' => 512,
+// 'not null' => FALSE,
+// ),
+// ),
+// 'primary key' => array('fid'),
+// );
+
+// $schema['fillpdf_fields'] = array(
+// 'fields' => array(
+// 'fid' => array(
+// 'type' => 'int',
+// 'unsigned' => TRUE,
+// 'not null' => TRUE,
+// ),
+// 'pdf_key' => array(
+// 'type' => 'varchar',
+// 'length' => 255,
+// 'not null' => TRUE,
+// ),
+// 'label' => array(
+// 'type' => 'varchar',
+// 'length' => 255,
+// 'not null' => TRUE,
+// ),
+// 'prefix' => array(
+// 'type' => 'varchar',
+// 'length' => 4096,
+// 'not null' => FALSE,
+// ),
+// 'value' => array(
+// 'type' => 'text',
+// 'size' => 'medium',
+// 'not null' => TRUE,
+// ),
+// 'suffix' => array(
+// 'type' => 'varchar',
+// 'length' => 4096,
+// 'not null' => FALSE,
+// ),
+// 'replacements' => array(
+// 'type' => 'text',
+// 'size' => 'normal',
+// 'not null' => FALSE,
+// ),
+// ),
+// 'primary key' => array('fid', 'pdf_key'),
+// );
return $schema;
}
-/**
- * Implements hook_install().
- */
-function fillpdf_install() {
-
-}
-
-/**
- * Implements hook_uninstall().
- */
-function fillpdf_uninstall() {
-
-}
-
-/**
- * Implements hook_update_N().
- */
-
-/**
- * Add field to store destination path for saving PDFs as files.
- */
-function fillpdf_update_7001() {
- if (!db_field_exists('fillpdf_forms', 'destination_path')) {
- db_add_field('fillpdf_forms', 'destination_path', array('type' => 'varchar', 'length' => 255, 'not null' => FALSE));
- }
-}
-
-/**
- * Add fields to store token replacements.
- */
-function fillpdf_update_7002() {
- if (!db_field_exists('fillpdf_forms', 'replacements')) {
- db_add_field('fillpdf_forms', 'replacements', array('type' => 'text', 'size' => 'normal', 'not null' => FALSE));
- }
- if (!db_field_exists('fillpdf_fields', 'replacements')) {
- db_add_field('fillpdf_fields', 'replacements', array('type' => 'text', 'size' => 'normal', 'not null' => FALSE));
- }
-}
-
-/**
- * Convert legacy configuration variables to new fillpdf_service variable and delete.
- */
-function fillpdf_update_7003() {
- $default = FALSE;
- global $conf;
- foreach (array('fillpdf_remote_service', 'fillpdf_local_service', 'fillpdf_local_php') as $variable_name) {
- if (isset($conf[$variable_name])) {
- if ($conf[$variable_name]) {
- $default = $variable_name;
- }
- variable_del($variable_name);
- }
- }
- if ($default) {
- $variable_name_map = array(
- 'fillpdf_local_php' => 'pdftk',
- 'fillpdf_local_service' => 'local',
- 'fillpdf_remote_service' => 'remote',
- );
- variable_set('fillpdf_service', $variable_name_map[$default]);
- }
-}
-
-/**
- * Add field to store default NID.
- */
-function fillpdf_update_7004() {
- if (!db_field_exists('fillpdf_forms', 'default_nid')) {
- db_add_field('fillpdf_forms', 'default_nid', array('type' => 'int', 'unsigned' => TRUE, 'not null' => FALSE));
- }
-}
-
-/**
- * Add database field to hold "Redirect to saved file" setting.
- */
-function fillpdf_update_7005() {
- if (!db_field_exists('fillpdf_forms', 'destination_redirect')) {
- db_add_field('fillpdf_forms', 'destination_redirect', array('type' => 'int', 'size' => 'tiny', 'unsigned' => TRUE, 'not null' => FALSE));
- }
-}
-
-/**
- * Add database fields for prefix and suffix.
- */
-function fillpdf_update_7006() {
- $schema = drupal_get_schema_unprocessed('fillpdf', 'fillpdf_fields');
- if (!db_field_exists('fillpdf_fields', 'prefix')) {
- db_add_field('fillpdf_fields', 'prefix', $schema['fields']['prefix']);
- }
- if (!db_field_exists('fillpdf_fields', 'suffix')) {
- db_add_field('fillpdf_fields', 'suffix', $schema['fields']['suffix']);
- }
-}
-
-/**
- * Add administrative title; make title longer.
- */
-function fillpdf_update_7101() {
- $schema = drupal_get_schema_unprocessed('fillpdf', 'fillpdf_forms');
- if (!db_field_exists('fillpdf_forms', 'admin_title')) {
- db_add_field('fillpdf_forms', 'admin_title', $schema['fields']['admin_title']);
- }
-
- db_change_field('fillpdf_forms', 'title', 'title', $schema['fields']['title']);
-}
+///**
+// * Implements hook_update_N().
+// */
+//
+///**
+// * Add field to store destination path for saving PDFs as files.
+// */
+//function fillpdf_update_7001() {
+// if (!db_field_exists('fillpdf_forms', 'destination_path')) {
+// db_add_field('fillpdf_forms', 'destination_path', array('type' => 'varchar', 'length' => 255, 'not null' => FALSE));
+// }
+//}
+//
+///**
+// * Add fields to store token replacements.
+// */
+//function fillpdf_update_7002() {
+// if (!db_field_exists('fillpdf_forms', 'replacements')) {
+// db_add_field('fillpdf_forms', 'replacements', array('type' => 'text', 'size' => 'normal', 'not null' => FALSE));
+// }
+// if (!db_field_exists('fillpdf_fields', 'replacements')) {
+// db_add_field('fillpdf_fields', 'replacements', array('type' => 'text', 'size' => 'normal', 'not null' => FALSE));
+// }
+//}
+//
+///**
+// * Convert legacy configuration variables to new fillpdf_service variable and delete.
+// */
+//function fillpdf_update_7003() {
+// $default = FALSE;
+// global $conf;
+// foreach (array('fillpdf_remote_service', 'fillpdf_local_service', 'fillpdf_local_php') as $variable_name) {
+// if (isset($conf[$variable_name])) {
+// if ($conf[$variable_name]) {
+// $default = $variable_name;
+// }
+// variable_del($variable_name);
+// }
+// }
+// if ($default) {
+// $variable_name_map = array(
+// 'fillpdf_local_php' => 'pdftk',
+// 'fillpdf_local_service' => 'local',
+// 'fillpdf_remote_service' => 'remote',
+// );
+// variable_set('fillpdf_service', $variable_name_map[$default]);
+// }
+//}
+//
+///**
+// * Add field to store default NID.
+// */
+//function fillpdf_update_7004() {
+// if (!db_field_exists('fillpdf_forms', 'default_nid')) {
+// db_add_field('fillpdf_forms', 'default_nid', array('type' => 'int', 'unsigned' => TRUE, 'not null' => FALSE));
+// }
+//}
+//
+///**
+// * Add database field to hold "Redirect to saved file" setting.
+// */
+//function fillpdf_update_7005() {
+// if (!db_field_exists('fillpdf_forms', 'destination_redirect')) {
+// db_add_field('fillpdf_forms', 'destination_redirect', array('type' => 'int', 'size' => 'tiny', 'unsigned' => TRUE, 'not null' => FALSE));
+// }
+//}
+//
+///**
+// * Add database fields for prefix and suffix.
+// */
+//function fillpdf_update_7006() {
+// $schema = drupal_get_schema_unprocessed('fillpdf', 'fillpdf_fields');
+// if (!db_field_exists('fillpdf_fields', 'prefix')) {
+// db_add_field('fillpdf_fields', 'prefix', $schema['fields']['prefix']);
+// }
+// if (!db_field_exists('fillpdf_fields', 'suffix')) {
+// db_add_field('fillpdf_fields', 'suffix', $schema['fields']['suffix']);
+// }
+//}
+//
+///**
+// * Add administrative title; make title longer.
+// */
+//function fillpdf_update_7101() {
+// $schema = drupal_get_schema_unprocessed('fillpdf', 'fillpdf_forms');
+// if (!db_field_exists('fillpdf_forms', 'admin_title')) {
+// db_add_field('fillpdf_forms', 'admin_title', $schema['fields']['admin_title']);
+// }
+//
+// db_change_field('fillpdf_forms', 'title', 'title', $schema['fields']['title']);
+//}
diff --git a/fillpdf.links.menu.yml b/fillpdf.links.menu.yml
index 94086f5..55d5d9a 100644
--- a/fillpdf.links.menu.yml
+++ b/fillpdf.links.menu.yml
@@ -2,4 +2,10 @@ fillpdf.settings:
title: FillPDF settings
description: "Configure tool to use with FillPDF."
route_name: fillpdf.settings
- parent: system.admin_config_media
\ No newline at end of file
+ parent: system.admin_config_media
+
+fillpdf.forms_admin:
+ title: FillPDF
+ description: Manage your PDFs
+ route_name: fillpdf.forms_admin
+ parent: system.admin_structure
\ No newline at end of file
diff --git a/fillpdf.module b/fillpdf.module
index 3fd1c64..7373121 100644
--- a/fillpdf.module
+++ b/fillpdf.module
@@ -5,9 +5,8 @@
* Allows mappings of PDFs to site content
*/
-// @todo: Convert this after settings page
//define("DEFAULT_SERVLET_URL", variable_get('fillpdf_remote_protocol', 'http') . "://" . variable_get('fillpdf_remote_endpoint', "fillpdf-service.com/xmlrpc.php"));
-define("DEFAULT_SERVLET_URL", 'https://fillpdf-service.com/xmlrpc.rpc'); // TODO: temporary
+//define("DEFAULT_SERVLET_URL", 'https://fillpdf-service.com/xmlrpc.rpc');
module_load_include('inc', 'fillpdf', 'fillpdf.admin');
/**
@@ -48,16 +47,6 @@ function fillpdf_menu() {
'type' => MENU_CALLBACK,
);
- // ------- Config ---------------------------
- $items['admin/config/media/fillpdf'] = array(
- 'title' => 'FillPDF settings',
- 'description' => 'Configure tool to use with FillPDF',
- 'page callback' => 'drupal_get_form',
- 'page arguments' => array('fillpdf_settings'),
- 'access arguments' => $access,
- 'type' => MENU_NORMAL_ITEM,
- );
-
// --------- Form ------------------------
$items['admin/structure/fillpdf'] = array(
'title' => 'FillPDF',
@@ -736,13 +725,13 @@ function fillpdf_parse_pdf($fid) {
$filename = db_query("SELECT url FROM {fillpdf_forms} WHERE fid = :fid", array(':fid' => $fid))->fetchField();
$content = _fillpdf_get_file_contents($filename, "<front>");
switch (variable_get('fillpdf_service')) {
- case 'remote': // use fillpdf-service.com's xmlrpc service (must be registered)
- $result = _fillpdf_xmlrpc_request(DEFAULT_SERVLET_URL, 'parse_pdf_fields', base64_encode($content));
- if ($result->error == TRUE) {
- drupal_goto('admin/structure/fillpdf');
- } // after setting error message
- $fields = $result->data;
- break;
+// case 'remote': // use fillpdf-service.com's xmlrpc service (must be registered)
+// $result = _fillpdf_xmlrpc_request(DEFAULT_SERVLET_URL, 'parse_pdf_fields', base64_encode($content));
+// if ($result->error == TRUE) {
+// drupal_goto('admin/structure/fillpdf');
+// } // after setting error message
+// $fields = $result->data;
+// break;
case 'local': // use local php/java bridge (must have Tomcat & JavaBridge installed on VPS or dedicated
$require = drupal_get_path('module', 'fillpdf') . '/lib/JavaBridge/java/Java.inc';
diff --git a/fillpdf.routing.yml b/fillpdf.routing.yml
index 85eccfa..af086c2 100644
--- a/fillpdf.routing.yml
+++ b/fillpdf.routing.yml
@@ -1,7 +1,19 @@
fillpdf.settings:
path: '/admin/config/media/fillpdf'
defaults:
- _form: '\Drupal\fillpdf\Form\FillpdfSettingsForm'
+ _form: '\Drupal\fillpdf\Form\FillPdfSettingsForm'
_title: 'FillPDF settings'
requirements:
_permission: 'administer pdfs'
+ options:
+ _admin_route: TRUE
+
+fillpdf.forms_admin:
+ path: '/admin/structure/fillpdf'
+ defaults:
+ _form: '\Drupal\fillpdf\Form\FillPdfOverviewForm'
+ _title: 'FillPDF'
+ requirements:
+ _permission: 'administer pdfs'
+ options:
+ _admin_route: TRUE
diff --git a/fillpdf.services.yml b/fillpdf.services.yml
new file mode 100644
index 0000000..71153e6
--- /dev/null
+++ b/fillpdf.services.yml
@@ -0,0 +1,4 @@
+services:
+ plugin.manager.fillpdf_backend:
+ class: Drupal\fillpdf\FillPdfBackendManager
+ parent: default_plugin_manager
\ No newline at end of file
diff --git a/src/Entity/FillPdfForm.php b/src/Entity/FillPdfForm.php
new file mode 100644
index 0000000..421aafc
--- /dev/null
+++ b/src/Entity/FillPdfForm.php
@@ -0,0 +1,72 @@
+<?php
+/**
+ * @file
+ * Contains \Drupal\fillpdf\Entity\FillPdfForm.
+ */
+
+namespace Drupal\fillpdf\Entity;
+use Drupal\Core\Entity\ContentEntityBase;
+use Drupal\Core\Entity\EntityTypeInterface;
+use Drupal\Core\Field\BaseFieldDefinition;
+use Drupal\fillpdf\FillPdfFormInterface;
+
+/**
+ * Defines the entity for managing uploaded FillPDF forms.
+ *
+ * @ContentEntityType(
+ * id = "fillpdf_form",
+ * label = @Translation("FillPDF form"),
+ * admin_permission = "administer pdfs",
+ * base_table = "fillpdf_forms",
+ * data_table = "fillpdf_forms_field_data",
+ * entity_keys = {
+ * "id" = "fid",
+ * "uuid" = "uuid"
+ * },
+ * )
+ */
+class FillPdfForm extends ContentEntityBase implements FillPdfFormInterface {
+
+ /**
+ * {@inheritdoc}
+ */
+ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
+ $fields = array();
+
+ $fields['fid'] = BaseFieldDefinition::create('integer')
+ ->setLabel(t('FillPDF Form ID'))
+ ->setDescription(t('The ID of the FillPdfForm entity.'))
+ ->setReadOnly(TRUE)
+ ->setSetting('unsigned', TRUE);
+
+ $fields['uuid'] = BaseFieldDefinition::create('uuid')
+ ->setLabel(t('UUID'))
+ ->setDescription(t('The UUID of the FillPdfForm entity.'))
+ ->setReadOnly(TRUE);
+
+ $fields['file'] = BaseFieldDefinition::create('entity_reference')
+ ->setLabel(t('The associated managed file.'))
+ ->setDescription(t('The associated managed file.'))
+ ->setSetting('target_type', 'file');
+
+ // @todo: Revisit this...I would probably need to store the entity and bundle types as well.
+// $fields['default_entity_id'] = BaseFieldDefinition::create('integer')
+// ->setLabel(t('Default entity ID'))
+// ->setDescription(t('The default entity ID to be filled from this FillPDF Form.'));
+
+ $fields['destination_path'] = BaseFieldDefinition::create('link')
+ ->setLabel(t('Destination file path for saving'))
+ ->setDescription(t('Subfolder in which to save the generated PDF.'));
+
+ $fields['destination_redirect'] = BaseFieldDefinition::create('boolean')
+ ->setLabel(t('Redirect browser to saved PDF'))
+ ->setDescription(t("Whether to redirect the browser to the newly-saved PDF or not. By default, it's provided as a download. In some browsers, this will show the PDF in the browser windows; others will still prompt the user to download it."));
+
+ $fields['admin_title'] = BaseFieldDefinition::create('string')
+ ->setLabel(t('Administrative description'))
+ ->setDescription(t('A description to help administrators more easily distinguish FillPDF Forms.'));
+
+ return $fields;
+ }
+
+}
\ No newline at end of file
diff --git a/src/Entity/FillPdfFormField.php b/src/Entity/FillPdfFormField.php
new file mode 100644
index 0000000..6f7192a
--- /dev/null
+++ b/src/Entity/FillPdfFormField.php
@@ -0,0 +1,84 @@
+<?php
+/**
+ * @file
+ * Contains \Drupal\fillpdf\Entity\FillPdfFormField.
+ */
+
+namespace Drupal\fillpdf\Entity;
+
+use Drupal\Core\Entity\Annotation\ContentEntityType;
+use Drupal\Core\Entity\ContentEntityBase;
+use Drupal\Core\Entity\EntityTypeInterface;
+use Drupal\Core\Field\BaseFieldDefinition;
+use Drupal\fillpdf\FillPdfFormFieldInterface;
+
+/**
+ * Defines the entity for managing PDF fields associated with uploaded FillPDF
+ * forms.
+ *
+ * @ContentEntityType(
+ * id = "fillpdf_form_field",
+ * label = @Translation("FillPDF form field"),
+ * admin_permission = "administer pdfs",
+ * base_table = "fillpdf_fields",
+ * data_table = "fillpdf_fields_field_data",
+ * entity_keys = {
+ * "id" = "ffid",
+ * "uuid" = "uuid"
+ * },
+ * )
+ */
+class FillPdfFormField extends ContentEntityBase implements FillPdfFormFieldInterface {
+
+ /**
+ * @inheritdoc
+ */
+ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
+ $fields = array();
+
+ $fields['ffid'] = BaseFieldDefinition::create('integer')
+ ->setLabel(t('FillPDF Form Field ID'))
+ ->setDescription(t('The ID of the FillPdfFormField entity.'))
+ ->setReadOnly(TRUE)
+ ->setSetting('unsigned', TRUE);
+
+ $fields['fillpdf_form'] = BaseFieldDefinition::create('entity_reference')
+ ->setLabel(t('FillPDF Form ID'))
+ ->setDescription(t('The ID of the FillPdfFormField entity.'))
+ ->setSetting('target_type', 'fillpdf_form');
+
+ $fields['uuid'] = BaseFieldDefinition::create('uuid')
+ ->setLabel(t('UUID'))
+ ->setDescription(t('The UUID of the FillPdfFormField entity.'))
+ ->setReadOnly(TRUE);
+
+ $fields['pdf_key'] = BaseFieldDefinition::create('string')
+ ->setLabel(t('PDF Key'))
+ ->setDescription(t('The name of the field in the PDF form.'));
+
+ $fields['label'] = BaseFieldDefinition::create('string')
+ ->setLabel(t('PDF Field Label'))
+ ->setDescription(t('A reminder to assist in remembering to which field a PDF key corresponds.'));
+
+ $fields['prefix'] = BaseFieldDefinition::create('string_long')
+ ->setLabel(t('Text before field value'))
+ ->setDescription(t('Text to add to the front of the field value unless the field value is blank.'));
+
+ $fields['value'] = BaseFieldDefinition::create('string_long')
+ ->setLabel(t('Fill pattern'))
+ ->setDescription(t('Text and tokens with which to fill in the PDF.'));
+
+ $fields['suffix'] = BaseFieldDefinition::create('string_long')
+ ->setLabel(t('Text after field value'))
+ ->setDescription(t('Text to add to the end of the field value unless the field value is blank.'));
+
+ // @todo: Can I do better on field type here? Maybe a multi-value string field?
+ // replacements
+ $fields['replacements'] = BaseFieldDefinition::create('string_long')
+ ->setLabel(t('Fill pattern transformations'))
+ ->setDescription(t('Pipe-separated mapping of specific values to replace with other values.'));
+
+ return $fields;
+ }
+
+}
diff --git a/src/FillPdfBackendManager.php b/src/FillPdfBackendManager.php
new file mode 100644
index 0000000..65bdb63
--- /dev/null
+++ b/src/FillPdfBackendManager.php
@@ -0,0 +1,37 @@
+<?php
+/**
+ * @file
+ * Contains \Drupal\fillpdf\FillPdfBackendManager.
+ */
+
+
+namespace Drupal\fillpdf;
+
+use Drupal\Core\Cache\CacheBackendInterface;
+use Drupal\Core\Extension\ModuleHandlerInterface;
+use Drupal\Core\Language\LanguageManager;
+use Drupal\Core\Plugin\DefaultPluginManager;
+
+class FillPdfBackendManager extends DefaultPluginManager implements FillPdfBackendManagerInterface {
+
+ /**
+ * Constructs a FillPdfBackendManager object.
+ *
+ * @param \Traversable $namespaces
+ * An object that implements \Traversable which contains the root paths
+ * keyed by the corresponding namespace to look for plugin implementations.
+ * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
+ * Cache backend instance to use.
+ * @param \Drupal\Core\Language\LanguageManager $language_manager
+ * The language manager.
+ * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
+ * The module handler to invoke the alter hook with.
+ */
+ public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
+ // @todo: Add a future FillPdfBackendPluginInterface to this?
+ parent::__construct('Plugin/FillPdfBackend', $namespaces, $module_handler);
+ $this->alterInfo('fillpdf_backend_info');
+ $this->setCacheBackend($cache_backend, 'fillpdf_backend_info_plugins');
+ }
+
+}
diff --git a/src/FillPdfBackendManagerInterface.php b/src/FillPdfBackendManagerInterface.php
new file mode 100644
index 0000000..db2e14b
--- /dev/null
+++ b/src/FillPdfBackendManagerInterface.php
@@ -0,0 +1,12 @@
+<?php
+/**
+ * @file
+ * Contains \Drupal\fillpdf\FillPdfBackendManagerInterface.
+ */
+
+
+namespace Drupal\fillpdf;
+
+interface FillPdfBackendManagerInterface {
+
+}
diff --git a/src/FillPdfBackendPluginInterface.php b/src/FillPdfBackendPluginInterface.php
new file mode 100644
index 0000000..61ee715
--- /dev/null
+++ b/src/FillPdfBackendPluginInterface.php
@@ -0,0 +1,46 @@
+<?php
+/**
+ * @file
+ * Contains \Drupal\fillpdf\FillPdfBackendPluginInterface.
+ */
+
+namespace Drupal\fillpdf;
+use Drupal\file\FileInterface;
+
+/**
+ * Defines the required interface for all FillPDF Backend plugins.
+ *
+ * @package Drupal\fillpdf
+ */
+interface FillPdfBackendPluginInterface {
+
+ /**
+ * Parse a PDF and return a list of its fields.
+ *
+ * @param FillPdfFormInterface $fillpdf_form The PDF whose fields
+ * are going to be parsed.
+ * @return array An array of FillPdfField entities containing metadata about
+ * the fields in the PDF. These can be iterated over and saved by the
+ * caller.
+ */
+ public function parse(FillPdfFormInterface $fillpdf_form);
+
+ /**
+ * Formerly known as merging. Accept an array of PDF field keys and field
+ * values and populate the PDF using them.
+ *
+ * @param FillPdfFormInterface $pdf_form The FillPdfForm referencing the file
+ * whose field values are going to be populated.
+ * @param array $fields An array of fields mapping PDF field keys to the
+ * values with which they should be replaced. Example array:
+ *
+ * array(
+ * 'Field 1' => 'value',
+ * 'Checkbox Field' => 'On',
+ * );
+ * @param array $options @todo: Define
+ * @return string The raw file contents of the new PDF; the caller has to
+ * handle saving or serving the file accordingly.
+ */
+ public function populateWithFieldData(FillPdfFormInterface $pdf_form, array $fields, array $options);
+}
diff --git a/src/FillPdfFormFieldInterface.php b/src/FillPdfFormFieldInterface.php
new file mode 100644
index 0000000..d766fe0
--- /dev/null
+++ b/src/FillPdfFormFieldInterface.php
@@ -0,0 +1,13 @@
+<?php
+/**
+ * @file
+ * Contains \Drupal\fillpdf\FillPdfFormFieldInterface.
+ */
+
+namespace Drupal\fillpdf;
+
+use Drupal\Core\Entity\ContentEntityInterface;
+
+interface FillPdfFormFieldInterface extends ContentEntityInterface {
+
+}
diff --git a/src/FillPdfFormInterface.php b/src/FillPdfFormInterface.php
new file mode 100644
index 0000000..6945112
--- /dev/null
+++ b/src/FillPdfFormInterface.php
@@ -0,0 +1,16 @@
+<?php
+/**
+ * @file
+ * Contains Drupal\fillpdf\FillPdfFormInterface.
+ */
+
+namespace Drupal\fillpdf;
+
+use Drupal\Core\Entity\ContentEntityInterface;
+use Drupal\user\EntityOwnerInterface;
+
+interface FillPdfFormInterface extends ContentEntityInterface {
+
+ // @todo: Add functions that must be implemented to interface once I know what they are.
+
+}
\ No newline at end of file
diff --git a/src/Form/FillPdfAdminFormBase.php b/src/Form/FillPdfAdminFormBase.php
new file mode 100644
index 0000000..e2e0b69
--- /dev/null
+++ b/src/Form/FillPdfAdminFormBase.php
@@ -0,0 +1,24 @@
+<?php
+/**
+ * @file
+ * Contains \Drupal\fillpdf\Form\FillPdfAdminFormBase.
+ */
+
+namespace Drupal\fillpdf\Form;
+use Drupal\Core\Form\FormBase;
+
+abstract class FillPdfAdminFormBase extends FormBase {
+ public $REPLACEMENTS_DESCRIPTION;
+
+ public function __construct() {
+ $this->REPLACEMENTS_DESCRIPTION = $this->t("<p>Tokens, such as those from CCK, sometimes output values that need additional
+ processing prior to being sent to the PDF. A common example is when a key within a CCK <em>Allowed values</em>
+ configuration does not match the field name or option value in the PDF that you would like to be selected but you
+ do not want to change the <em>Allowed values</em> key.</p><p>This field will replace any matching values with the
+ replacements you specify. Specify <strong>one replacement per line</strong> in the format
+ <em>original value|replacement value</em>. For example, <em>yes|Y</em> will fill the PDF with
+ <strong><em>Y</em></strong> anywhere that <strong><em>yes</em></strong> would have originally
+ been used. <p>Note that omitting the <em>replacement value</em> will replace <em>original value</em>
+ with a blank, essentially erasing it.</p>");
+ }
+}
diff --git a/src/Form/FillPdfOverviewForm.php b/src/Form/FillPdfOverviewForm.php
new file mode 100644
index 0000000..b7d0356
--- /dev/null
+++ b/src/Form/FillPdfOverviewForm.php
@@ -0,0 +1,231 @@
+<?php
+/**
+ * @file
+ * Contains \Drupal\fillpdf\Form\FillPdfOverviewForm.
+ */
+namespace Drupal\fillpdf\Form;
+
+use Drupal\Component\Plugin\Exception\PluginNotFoundException;
+use Drupal\Core\Extension\ModuleHandlerInterface;
+use Drupal\Core\Form\FormStateInterface;
+use Drupal\Component\Utility\String;
+use Drupal\Core\Session\AccountInterface;
+use Drupal\Core\Url;
+use Drupal\file\Entity\File;
+use Drupal\fillpdf\Entity\FillPdfForm;
+use Drupal\fillpdf\FillPdfBackendManagerInterface;
+use Drupal\fillpdf\FillPdfBackendPluginInterface;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+class FillPdfOverviewForm extends FillPdfAdminFormBase {
+ /**
+ * The backend manager (finds the filling plugin the user selected).
+ *
+ * @var \Drupal\fillpdf\FillPdfBackendManagerInterface
+ */
+ protected $backendManager;
+
+ /** @var ModuleHandlerInterface $module_handler */
+ protected $module_handler;
+
+ /** @var AccountInterface $current_user */
+ protected $current_user;
+
+ /**
+ * Returns a unique string identifying the form.
+ *
+ * @return string
+ * The unique string identifying the form.
+ */
+ public function getFormId() {
+ return 'fillpdf_forms_admin';
+ }
+
+ public function __construct(ModuleHandlerInterface $module_handler, FillPdfBackendManagerInterface $backend_manager, AccountInterface $current_user) {
+ parent::__construct();
+ $this->backendManager = $backend_manager;
+ $this->moduleHandler = $module_handler;
+ $this->currentUser = $current_user;
+ }
+
+ /**
+ * @inheritdoc
+ */
+ public static function create(ContainerInterface $container) {
+ return new static(
+ // Load the plugin manager.
+ $container->get('module_handler'),
+ $container->get('plugin.manager.fillpdf_backend'),
+ $container->get('current_user')
+ );
+ }
+
+ /**
+ * Form constructor.
+ *
+ * @param array $form
+ * An associative array containing the structure of the form.
+ * @param \Drupal\Core\Form\FormStateInterface $form_state
+ * The current state of the form.
+ *
+ * @return array
+ * The form structure.
+ */
+ public function buildForm(array $form, FormStateInterface $form_state) {
+ // @todo: Convert to using data from entity or something.
+// $result = db_query("SELECT admin_title, title, url, fid FROM {fillpdf_forms} ORDER BY admin_title");
+ $result = array();
+ $header = array(
+ $this->t('Administrative title'),
+ $this->t('Title'),
+ $this->t('Location'),
+ array(
+ 'data' => t('Operations'),
+ 'colspan' => '4',
+ ),
+ );
+ $rows = array();
+ $form['existing_forms'] = array(
+ '#theme' => 'table',
+ '#header' => $header,
+ '#attributes' => array('id' => 'fillpdf'),
+ '#empty' => $this->t('No content available.'),
+ );
+
+ foreach ($result as $pdf_form) {
+ $row = array(
+ String::checkPlain($pdf_form->admin_title),
+ String::checkPlain($pdf_form->title),
+ String::checkPlain($pdf_form->url),
+ // @todo: Convert to routes.
+ $this->l($this->t('Edit'), "admin/structure/fillpdf/$pdf_form->fid"),
+ $this->l($this->t('Delete'), "admin/structure/fillpdf/$pdf_form->fid/delete"),
+ $this->l($this->t('Export field mappings'), "admin/structure/fillpdf/$pdf_form->fid/export"),
+ $this->l($this->t('Import field mappings'), "admin/structure/fillpdf/$pdf_form->fid/import"),
+ );
+ // @todo: Convert to adding the rows to the table like on
+ $rows[] = $row;
+ }
+
+ $config = $this->config('fillpdf.settings');
+ // Only show PDF upload form if fillpdf is configured.
+ if ($config->get('fillpdf_service_backend')) {
+ // If using FillPDF Service, ensure XML-RPC module is present.
+ if ($config->get('fillpdf_service_backend') != 'fillpdf_service' || $this->moduleHandler->moduleExists('xmlrpc')) {
+ $form['upload_pdf'] = array(
+ '#type' => 'file',
+ '#title' => 'Upload',
+ '#description' => 'Upload a PDF template to create a new form',
+ );
+
+ $form['submit'] = array(
+ '#type' => 'submit',
+ '#value' => $this->t('Upload'),
+ '#weight' => 15,
+ );
+ }
+ else {
+ drupal_set_message($this->t('You must install the <a href="@xmlrpc">contributed XML-RPC module</a> in order to use FillPDF Service as your PDF-filling method.', array('@xmlrpc' => Url::fromUri('https://drupal.org/project/xmlrpc'))), 'error');
+ }
+ }
+ else {
+ $form['message'] = array(
+ '#markup' => '<p>' . $this->t('Before you can upload PDF files, you must !link.', array('!link' => $this->l($this->t('configure FillPDF'), Url::fromRoute('fillpdf.settings')))) . '</p>',
+ );
+ drupal_set_message($this->t('FillPDF is not configured.'), 'error');
+ }
+ return $form;
+ }
+
+ public function validateForm(array &$form, FormStateInterface $form_state) {
+ $file_upload = $this->getRequest()->files->get('files[upload_pdf]', NULL, TRUE);
+ /**
+ * @var $file_upload \Symfony\Component\HttpFoundation\File\UploadedFile
+ */
+ if ($file_upload && $file_upload->isValid()) {
+ // Move it to somewhere we know.
+ $uploaded_filename = $file_upload->getClientOriginalName();
+
+ // Ensure the destination is unique; we deliberately use managed files,
+ // but they are keyed on file URI, so we can't save the same one twice.
+ $destination = file_destination(file_build_uri('fillpdf/' . $uploaded_filename), FILE_EXISTS_RENAME);
+
+ // Ensure our directory exists.
+ $fillpdf_directory = file_build_uri('fillpdf');
+ $directory_exists = file_prepare_directory($fillpdf_directory, FILE_CREATE_DIRECTORY + FILE_MODIFY_PERMISSIONS);
+
+ if ($directory_exists) {
+ $file_moved = drupal_move_uploaded_file($file_upload->getRealPath(), $destination);
+
+ if ($file_moved) {
+ // Create a File object from the uploaded file.
+ $new_file = File::create(array(
+ 'uri' => $destination,
+ 'uid' => $this->currentUser()->id(),
+ ));
+
+ // TODO: test this
+ $errors = file_validate_extensions($new_file, 'pdf');
+
+ if (!empty($errors)) {
+ $form_state->setErrorByName('upload_pdf', $this->t('Only PDF files are supported, and they must end in .pdf.'));
+ }
+ else {
+ $form_state->setValue('upload_pdf', $new_file);
+ }
+ }
+ else {
+ $form_state->setErrorByName('upload_pdf', $this->t("Could not move your uploaded file from PHP's temporary location to Drupal file storage."));
+ }
+ }
+ else {
+ $form_state->setErrorByName('upload_pdf', $this->t('Could not automatically create the <em>fillpdf</em> subdirectory. Please create this manually before uploading your PDF form.'));
+ }
+ }
+ else {
+ $form_state->setErrorByName('upload_pdf', $this->t('Your PDF could not be uploaded. Did you select one?'));
+ }
+ }
+
+ /**
+ * Form submission handler.
+ *
+ * @param array $form
+ * An associative array containing the structure of the form.
+ * @param \Drupal\Core\Form\FormStateInterface $form_state
+ * The current state of the form.
+ */
+ public function submitForm(array &$form, FormStateInterface $form_state) {
+ // Save the file to get an fid, and then create a FillPdfForm record
+ // based off that.
+ /** @var \Drupal\file\FileInterface $file */
+ $file = $form_state->getValue('upload_pdf');
+ $file->save(); // Save the file so we can get an fid
+
+ $fillpdf_form = FillPdfForm::create(array(
+ 'file' => $file,
+ 'title' => $file->filename,
+ ));
+
+ // Save PDF configuration before parsing. We'll add a button to let them attempt
+ // re-parsing if it fails.
+ $fillpdf_form->save();
+
+ $config = $this->config('fillpdf.settings');
+ $fillpdf_service = $config->get('fillpdf_service_backend');
+
+ try {
+ /** @var FillPdfBackendPluginInterface $backend */
+ $backend = $this->backendManager->createInstance($fillpdf_service, $config->get());
+ }
+ catch (PluginNotFoundException $exception) {
+ $backend = NULL;
+ }
+
+ if ($backend) {
+ // Attempt to parse the fields in the PDF.
+ // TODO: Actually parse the PDF.
+ $fields = $backend->parse($fillpdf_form);
+ }
+ }
+}
\ No newline at end of file
diff --git a/src/Form/FillpdfSettingsForm.php b/src/Form/FillpdfSettingsForm.php
index 7c23d3c..8f5b915 100644
--- a/src/Form/FillpdfSettingsForm.php
+++ b/src/Form/FillpdfSettingsForm.php
@@ -2,7 +2,7 @@
/**
* @file
- * Contains \Drupal\fillpdf\Form\FillpdfSettingsForm.
+ * Contains \Drupal\fillpdf\Form\FillPdfSettingsForm.
*/
namespace Drupal\fillpdf\Form;
use Drupal\Core\Form\ConfigFormBase;
@@ -11,20 +11,20 @@ use Drupal\Core\Url;
use Drupal\fillpdf\Component\Utility\Fillpdf;
-class FillpdfSettingsForm extends ConfigFormBase {
+class FillPdfSettingsForm extends ConfigFormBase {
public function getFormId() {
return 'fillpdf_settings';
}
public function buildForm(array $form, FormStateInterface $form_state) {
$config = $this->config('fillpdf.settings');
- $fillpdf_service = $config->get('fillpdf_service');
+ $fillpdf_service = $config->get('fillpdf_service_backend');
// Assemble service options. Warning messages will be added next as needed.
$options = array(
'pdftk' => $this->t('Use locally-installed pdftk: You will need a VPS or a dedicated server so you can install pdftk: (!see_documentation).', array('!see_documentation' => $this->l($this->t('see documentation'), Url::fromUri('http://drupal.org/documentation/modules/fillpdf')))),
'local' => $this->t('Use locally-installed PHP/JavaBridge: You will need a VPS or dedicated server so you can deploy PHP/JavaBridge on Apache Tomcat: (!see_documentation).', array('!see_documentation' => $this->l($this->t('see documentation'), Url::fromUri('http://drupal.org/documentation/modules/fillpdf')))),
- 'remote' => $this->t('Use FillPDF Service: Sign up for <a href="https://fillpdf-service.com">FillPDF Service</a>.'),
+ 'fillpdf_service' => $this->t('Use FillPDF Service: Sign up for <a href="https://fillpdf-service.com">FillPDF Service</a>.'),
);
// Check for JavaBridge.
@@ -38,26 +38,26 @@ class FillpdfSettingsForm extends ConfigFormBase {
$options['pdftk'] .= '<div class="messages warning">' . $this->t('pdftk is not properly installed.') . '</div>';
}
- $form['fillpdf_service'] = array(
+ $form['fillpdf_service_backend'] = array(
'#type' => 'radios',
'#title' => $this->t('PDF-filling service'),
'#description' => $this->t('This module requires the use of one of several external PDF manipulation tools. Choose the service you would like to use.'),
- '#default_value' => $fillpdf_service,
+ '#default_value' => !empty($fillpdf_service) ? $fillpdf_service : 'fillpdf_service',
'#options' => $options,
);
- $form['remote'] = array(
+ $form['fillpdf_service'] = array(
'#type' => 'fieldset',
'#title' => $this->t('Configure FillPDF Service'),
'#collapsible' => TRUE,
- '#collapsed' => $fillpdf_service !== 'remote',
+ '#collapsed' => $fillpdf_service !== 'fillpdf_service',
);
- $form['remote']['fillpdf_api_key'] = array(
+ $form['fillpdf_service']['fillpdf_api_key'] = array(
'#type' => 'textfield',
'#title' => $this->t('API Key'),
'#default_value' => $config->get('fillpdf_api_key', ''),
'#description' => $this->t('You need to sign up for an API key at <a href="https://fillpdf-service.com">FillPDF Service</a>'),
);
- $form['remote']['fillpdf_remote_protocol'] = array(
+ $form['fillpdf_service']['fillpdf_remote_protocol'] = array(
'#type' => 'radios',
'#title' => $this->t('Use HTTPS?'),
'#description' => $this->t('It is recommended to select <em>Use HTTPS</em> for this option. Doing so will help prevent
@@ -96,7 +96,7 @@ class FillpdfSettingsForm extends ConfigFormBase {
public function submitForm(array &$form, FormStateInterface $form_state) {
// Save form values.
$this->config('fillpdf.settings')
- ->set('fillpdf_service', $form_state->getValue('fillpdf_service'))
+ ->set('fillpdf_service_backend', $form_state->getValue('fillpdf_service_backend'))
->set('fillpdf_api_key', $form_state->getValue('fillpdf_api_key'))
->set('fillpdf_remote_protocol', $form_state->getValue('fillpdf_remote_protocol'))
->set('fillpdf_pdftk_path', $form_state->getValue('fillpdf_pdftk_path'))
diff --git a/src/Plugin/FillPdfBackend/FillPdfServiceFillPdfBackend.php b/src/Plugin/FillPdfBackend/FillPdfServiceFillPdfBackend.php
new file mode 100644
index 0000000..496695f
--- /dev/null
+++ b/src/Plugin/FillPdfBackend/FillPdfServiceFillPdfBackend.php
@@ -0,0 +1,121 @@
+<?php
+/**
+ * @file
+ * Contains \Drupal\fillpdf\Plugin\FillPdfBackend\FillPdfServiceFillPdfBackend.
+ */
+
+namespace Drupal\fillpdf\Plugin\FillPdfBackend;
+
+use Drupal\Component\Annotation\Plugin;
+use Drupal\Core\Config\ConfigFactoryInterface;
+use Drupal\Core\Config\ConfigManagerInterface;
+use Drupal\Core\Url;
+use Drupal\file\FileInterface;
+use Drupal\fillpdf\Entity\FillPdfFormField;
+use Drupal\fillpdf\FillPdfBackendPluginInterface;
+use Drupal\fillpdf\FillPdfFormInterface;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * @Plugin(
+ * id = "fillpdf_service",
+ * label = @Translation("FillPDF Service")
+ * )
+ */
+class FillPdfServiceFillPdfBackend implements FillPdfBackendPluginInterface {
+ /** @var string $fillPdfServiceEndpoint */
+ protected $fillPdfServiceEndpoint;
+
+ /** @var array $config */
+ protected $config;
+
+ public function __construct(array $config) {
+ // TODO: Remove hardcoding.
+ $this->config = $config;
+ $this->fillPdfServiceEndpoint = "{$this->config['fillpdf_remote_protocol']}://{$this->config['fillpdf_remote_endpoint']}";
+ }
+
+ /**
+ * @inheritdoc
+ * @param \Drupal\fillpdf\FillPdfFormInterface $fillpdf_form
+ * @return array
+ */
+ public function parse(FillPdfFormInterface $fillpdf_form) {
+ // @todo: Is there a better way to do this?
+ $file = File::load($fillpdf_form->file->target_id);
+ $content = file_get_contents($file->getFileUri());
+
+ $result = $this->xmlRpcRequest('parse_pdf_fields', base64_encode($content));
+
+ // TODO: Don't do magic error handling. Throw an exception and let the caller decide what to do. Make my own exception class (see PluginNotFoundException for inspiration).
+// if ($result->error == TRUE) {
+// drupal_goto('admin/structure/fillpdf');
+// } // after setting error message
+
+ $fields = $result->data;
+
+ $form_fields = array();
+
+ // TODO: Split out $result->data into an array of FillPdfField instances.
+ foreach ((array) $fields as $key => $arr) {
+ if ($arr['type']) { // Don't store "container" fields
+ $arr['name'] = str_replace('�', '', $arr['name']); // pdftk sometimes inserts random � markers - strip these out. NOTE: This may break forms that actually DO contain this pattern, but 99%-of-the-time functionality is better than merge failing due to improper parsing.
+ $field = FillPdfFormField::create(
+ array(
+ 'fillpdf_form' => $fillpdf_form->id(),
+ 'pdf_key' => $arr['name'],
+ 'value' => '',
+ )
+ );
+
+ $form_fields[] = $field;
+ }
+ }
+
+ return $form_fields;
+ }
+
+ /**
+ * @inheritdoc
+ */
+ public function populateWithFieldData(FillPdfFormInterface $pdf_form, array $fields, array $options) {
+ // TODO: Implement populateWithFieldData() method.
+ }
+
+
+ /**
+ * Make an XML_RPC request.
+ *
+ * @param $method
+ * @return stdClass
+ */
+ protected function xmlRpcRequest($method /** $args */) {
+ $url = $this->fillPdfServiceEndpoint;
+ $args = func_get_args();
+
+ // Fix up the array for Drupal 7 xmlrpc() function style
+ $args = array($args[0] => array_slice($args, 1));
+ $result = xmlrpc($url, $args);
+
+ $ret = new \stdClass;
+
+ // TODO: Exceptions, not error messages
+ if (isset($result['error'])) {
+// drupal_set_message($result['error'], 'error');
+ $ret->error = TRUE;
+ }
+ elseif ($result == FALSE || xmlrpc_error()) {
+ $error = xmlrpc_error();
+ $ret->error = TRUE;
+// drupal_set_message(t('There was a problem contacting the FillPDF service.
+// It may be down, or you may not have internet access. [ERROR @code: @message]',
+// array('@code' => $error->code, '@message' => $error->message)), 'error');
+ }
+ else {
+ $ret->data = $result['data'];
+ $ret->error = FALSE;
+ }
+ return $ret;
+ }
+
+}
--
GitLab