Your confirmation number is [webform-submission:values:confirmation_number].
confirmation_url: '' confirmation_attributes: { } confirmation_back: true @@ -147,9 +147,6 @@ handlers: status: true weight: 1 settings: - insert_url: 'http://default/webform_test/remote_post/insert' - update_url: 'http://default/webform_test/remote_post/update' - delete_url: 'http://default/webform_test/remote_post/delete' type: x-www-form-urlencoded excluded_data: serial: serial @@ -170,13 +167,21 @@ handlers: entity_id: entity_id sticky: sticky notes: notes + confirmation_number: confirmation_number custom_data: | custom_all: true - custom_title: '[webform:title]: Submission #[webform_submission:serial]' - insert_custom_data: | - custom_insert: true - update_custom_data: | - custom_update: true - delete_custom_data: | - custom_delete: true + custom_options: '' debug: true + completed_url: '/webform_example_remote_post/completed' + completed_custom_data: | + custom_completed: true + updated_url: '/webform_example_remote_post/updated' + updated_custom_data: | + custom_updated: true + deleted_url: '/webform_example_remote_post/deleted' + deleted_custom_data: | + custom_deleted: true + draft_url: '' + draft_custom_data: '' + converted_url: '' + converted_custom_data: '' diff --git a/modules/webform_example_remote_post/src/Controller/WebformExampleRemotePostController.php b/modules/webform_example_remote_post/src/Controller/WebformExampleRemotePostController.php new file mode 100644 index 00000000..5ffd3111 --- /dev/null +++ b/modules/webform_example_remote_post/src/Controller/WebformExampleRemotePostController.php @@ -0,0 +1,36 @@ + 'success', + 'message' => (string) $this->t('Processed @type request.', ['@type' => $type]), + 'confirmation_number' => $random->name(20, TRUE), + ]; + return new JsonResponse($json, 200); + } + +} diff --git a/modules/webform_example_remote_post/webform_example_remote_post.info.yml b/modules/webform_example_remote_post/webform_example_remote_post.info.yml new file mode 100644 index 00000000..16b8716e --- /dev/null +++ b/modules/webform_example_remote_post/webform_example_remote_post.info.yml @@ -0,0 +1,7 @@ +name: 'Webform Remote Post Example' +type: module +description: 'Provides an example of a webform submission posted to a remote server.' +package: 'Webform example' +core: 8.x +dependencies: + - 'drupal:webform' diff --git a/modules/webform_example_remote_post/webform_example_remote_post.module b/modules/webform_example_remote_post/webform_example_remote_post.module new file mode 100644 index 00000000..7f468df2 --- /dev/null +++ b/modules/webform_example_remote_post/webform_example_remote_post.module @@ -0,0 +1,34 @@ +getHandler('remote_post'); + + $configuration = $handler->getConfiguration(); + $states = ['completed', 'updated', 'deleted']; + foreach ($states as $state) { + if ($configuration['settings'][$state . '_url'] === "/webform_example_remote_post/$state") { + $configuration['settings'][$state . '_url'] = Url::fromRoute( + 'webform_example_remote_post.remote_post', + ['type' => $state], + ['absolute' => TRUE] + )->toString(); + } + } + $handler->setConfiguration($configuration); + } +} diff --git a/modules/webform_example_remote_post/webform_example_remote_post.routing.yml b/modules/webform_example_remote_post/webform_example_remote_post.routing.yml new file mode 100644 index 00000000..c46a7ab9 --- /dev/null +++ b/modules/webform_example_remote_post/webform_example_remote_post.routing.yml @@ -0,0 +1,7 @@ +webform_example_remote_post.remote_post: + path: '/webform_example_remote_post/{type}' + defaults: + _controller: '\Drupal\webform_example_remote_post\Controller\WebformExampleRemotePostController::index' + requirements: + # Example remote post handler does not require any access controls. + _access: 'TRUE' diff --git a/src/Plugin/WebformHandler/RemotePostWebformHandler.php b/src/Plugin/WebformHandler/RemotePostWebformHandler.php index 538b7f15..5b918a9b 100644 --- a/src/Plugin/WebformHandler/RemotePostWebformHandler.php +++ b/src/Plugin/WebformHandler/RemotePostWebformHandler.php @@ -8,6 +8,7 @@ use Drupal\Core\Extension\ModuleHandlerInterface; use Drupal\Core\Entity\EntityTypeManagerInterface; use Drupal\Core\Form\FormStateInterface; use Drupal\webform\Plugin\WebformHandlerBase; +use Drupal\webform\WebformInterface; use Drupal\webform\WebformSubmissionInterface; use Drupal\webform\WebformTokenManagerInterface; use GuzzleHttp\ClientInterface; @@ -84,13 +85,16 @@ class RemotePostWebformHandler extends WebformHandlerBase { */ public function getSummary() { $configuration = $this->getConfiguration(); - - // If the saving of results is disabled clear update and delete URL. - if ($this->getWebform()->getSetting('results_disabled')) { - $configuration['settings']['update_url'] = ''; - $configuration['settings']['delete_url'] = ''; + if (!$this->isResultsEnabled()) { + $configuration['settings']['updated_url'] = ''; + $configuration['settings']['deleted_url'] = ''; + } + if (!$this->isDraftEnabled()) { + $configuration['settings']['draft_url'] = ''; + } + if (!$this->isConvertEnabled()) { + $configuration['settings']['converted_url'] = ''; } - return [ '#settings' => $configuration['settings'], ] + parent::getSummary(); @@ -104,15 +108,21 @@ class RemotePostWebformHandler extends WebformHandlerBase { $excluded_data = array_combine($field_names, $field_names); return [ 'type' => 'x-www-form-urlencoded', - 'insert_url' => '', - 'update_url' => '', - 'delete_url' => '', 'excluded_data' => $excluded_data, 'custom_data' => '', - 'insert_custom_data' => '', - 'update_custom_data' => '', - 'delete_custom_data' => '', + 'custom_options' => '', 'debug' => FALSE, + // States. + 'completed_url' => '', + 'completed_custom_data' => '', + 'updated_url' => '', + 'updated_custom_data' => '', + 'deleted_url' => '', + 'deleted_custom_data' => '', + 'draft_url' => '', + 'draft_custom_data' => '', + 'converted_url' => '', + 'converted_custom_data' => '', ]; } @@ -121,33 +131,91 @@ class RemotePostWebformHandler extends WebformHandlerBase { */ public function buildConfigurationForm(array $form, FormStateInterface $form_state) { $webform = $this->getWebform(); - $results_disabled = $webform->getSetting('results_disabled'); - - $form['insert_url'] = [ - '#type' => 'url', - '#title' => $this->t('Insert URL'), - '#description' => $this->t('The full URL to POST to when a new webform submission is saved. E.g. http://www.mycrm.com/form_insert_handler.php'), - '#required' => TRUE, - '#default_value' => $this->configuration['insert_url'], - ]; - $form['update_url'] = [ - '#type' => 'url', - '#title' => $this->t('Update URL'), - '#description' => $this->t('The full URL to POST to when an existing webform submission is updated. E.g. http://www.mycrm.com/form_insert_handler.php'), - '#default_value' => $this->configuration['update_url'], - '#access' => !$results_disabled, + // States + $states = [ + WebformSubmissionInterface::STATE_COMPLETED => [ + 'state' => $this->t('completed'), + 'label' => $this->t('Completed'), + 'description' => $this->t('Post data when submission is completed.'), + 'access' => TRUE, + ], + WebformSubmissionInterface::STATE_UPDATED => [ + 'state' => $this->t('updated'), + 'label' => $this->t('Updated'), + 'description' => $this->t('Post data when submission is updated.'), + 'access' => $this->isResultsEnabled(), + ], + WebformSubmissionInterface::STATE_DELETED => [ + 'state' => $this->t('deleted'), + 'label' => $this->t('Deleted'), + 'description' => $this->t('Post data when submission is deleted.'), + 'access' => $this->isResultsEnabled(), + ], + WebformSubmissionInterface::STATE_DRAFT => [ + 'state' => $this->t('draft'), + 'label' => $this->t('Draft'), + 'description' => $this->t('Post data when draft is saved.'), + 'access' => $this->isDraftEnabled(), + ], + WebformSubmissionInterface::STATE_CONVERTED => [ + 'state' => $this->t('converted'), + 'label' => $this->t('Converted'), + 'description' => $this->t('Post data when anonymous submission is converted to authenticated.'), + 'access' => $this->isConvertEnabled(), + ], ]; + foreach ($states as $state => $state_item) { + $state_url = $state . '_url'; + $state_custom_data = $state . '_custom_data'; + $t_args = [ + '@state' => $state_item['state'], + '@title' => $state_item['label'], + '@url' => 'http://www.mycrm.com/form_' . $state . '_handler.php' + ]; + $form[$state] = [ + '#type' => 'details', + '#open' => ($state === WebformSubmissionInterface::STATE_COMPLETED), + '#title' => $state_item['label'], + '#access' => $state_item['access'], + ]; + $form[$state]['description'] = [ + '#markup' => $state_item['description'], + '#prefix' => '',
'#suffix' => '',
],
];
- $build['returned'] = ['#markup' => '',
@@ -459,7 +539,46 @@ class RemotePostWebformHandler extends WebformHandlerBase {
];
}
+ // Message.
+ $build['message'] = ['#markup' => '
'];
+ $build['message_message'] = [
+ '#type' => 'item',
+ '#wrapper_attributes' => ['style' => 'margin: 0'],
+ '#title' => $this->t('Message:'),
+ '#markup' => $message,
+ ];
+
drupal_set_message(\Drupal::service('renderer')->renderPlain($build), $type);
}
+ /**
+ * Determine if saving of results is enabled.
+ *
+ * @return bool
+ * TRUE if saving of results is enabled.
+ */
+ protected function isResultsEnabled() {
+ return ($this->getWebform()->getSetting('results_disabled') === FALSE);
+ }
+
+ /**
+ * Determine if saving of draft is enabled.
+ *
+ * @return bool
+ * TRUE if saving of draft is enabled.
+ */
+ protected function isDraftEnabled() {
+ return $this->isResultsEnabled() && ($this->getWebform()->getSetting('draft') != WebformInterface::DRAFT_NONE);
+ }
+
+ /**
+ * Determine if converting anoynmous submissions to authenticated is enabled.
+ *
+ * @return bool
+ * TRUE if converting anoynmous submissions to authenticated is enabled.
+ */
+ protected function isConvertEnabled() {
+ return $this->isDraftEnabled() && ($this->getWebform()->getSetting('form_convert_anonymous') === TRUE);
+ }
+
}
diff --git a/src/Tests/Handler/WebformHandlerRemotePostTest.php b/src/Tests/Handler/WebformHandlerRemotePostTest.php
index fae10476..4cb07b56 100644
--- a/src/Tests/Handler/WebformHandlerRemotePostTest.php
+++ b/src/Tests/Handler/WebformHandlerRemotePostTest.php
@@ -3,6 +3,7 @@
namespace Drupal\webform\Tests\Handler;
use Drupal\webform\Entity\Webform;
+use Drupal\webform\Entity\WebformSubmission;
use Drupal\webform\Tests\WebformTestBase;
/**
@@ -17,7 +18,7 @@ class WebformHandlerRemotePostTest extends WebformTestBase {
*
* @var array
*/
- public static $modules = ['webform', 'webform_test_handler'];
+ public static $modules = ['webform', 'webform_test_handler_remote_post'];
/**
* Webforms to load.
@@ -30,73 +31,109 @@ class WebformHandlerRemotePostTest extends WebformTestBase {
* Test remote post handler.
*/
public function testRemotePostHandler() {
- /** @var \Drupal\webform\WebformInterface $webform_handler_remote */
- $webform_handler_remote = Webform::load('test_handler_remote_post');
-
$this->drupalLogin($this->rootUser);
- // Check remote post 'create' operation.
- $sid = $this->postSubmission($webform_handler_remote);
- $this->assertPattern('#\s+insert#ms');
- $this->assertRaw('custom_insert: true');
- $this->assertRaw('custom_all: true');
- $this->assertRaw("custom_title: 'Test: Handler: Remote post: Submission #$sid'");
- $this->assertRaw('first_name: John');
- $this->assertRaw('last_name: Smith');
- $this->assertRaw('email: from@example.com');
- $this->assertRaw("subject: '{subject}'");
- $this->assertRaw("message: '{message}'");
- $this->assertNoRaw("sid: '$sid'");
+ /** @var \Drupal\webform\WebformInterface $webform */
+ $webform = Webform::load('test_handler_remote_post');
+
+ // Check 'completed' operation.
+ $sid = $this->postSubmission($webform);
+ $webform_submission = WebformSubmission::load($sid);
+ $this->assertRaw("form_params:
+ custom_completed: true
+ custom_data: true
+ response_type: '200'
+ first_name: John
+ last_name: Smith");
+ $this->assertRaw('Processed completed request.');
+
+ // Check confirmation number is set via the
+ // [webform_handler:remote_post:completed:confirmation_number] token.
+ $this->assertRaw('Your confirmation number is ' . $webform_submission->getData('confirmation_number') . '.');
+
+ // Check custom header.
+ $this->assertRaw('{"custom_header":"true"}');
- // Check remote post 'update' operation.
+ // Sleep for 1 second to make sure submission timestamp is updated.
+ sleep(1);
+
+ // Check 'updated' operation.
$this->drupalPostForm("admin/structure/webform/manage/test_handler_remote_post/submission/$sid/edit", [], t('Save'));
- $this->assertRaw('custom_update: true');
- $this->assertRaw('custom_all: true');
- $this->assertRaw("custom_title: 'Test: Handler: Remote post: Submission #$sid'");
- $this->assertRaw('first_name: John');
- $this->assertPattern('#\s+update#ms');
+ $this->assertRaw("form_params:
+ custom_updated: true
+ custom_data: true
+ response_type: '200'
+ first_name: John
+ last_name: Smith");
+ $this->assertRaw('Processed updated request.');
- // Check remote post 'delete' operation.
+ // Check 'deleted`' operation.
$this->drupalPostForm("admin/structure/webform/manage/test_handler_remote_post/submission/$sid/delete", [], t('Delete'));
- $this->assertRaw('custom_delete: true');
- $this->assertRaw('custom_all: true');
- $this->assertRaw("custom_title: 'Test: Handler: Remote post: Submission #$sid'");
- $this->assertRaw('first_name: John');
- $this->assertPattern('#\s+delete#ms');
+ $this->assertRaw("form_params:
+ custom_deleted: true
+ custom_data: true
+ first_name: John
+ last_name: Smith
+ response_type: '200'");
+ $this->assertRaw('Processed deleted request.');
+
+ // Switch anonymous user.
+ $this->drupalLogout();
- // Check including data.
- $handler = $webform_handler_remote->getHandler('remote_post');
+ // Check 'draft' operation.
+ $this->postSubmission($webform, [], t('Save Draft'));
+ $this->assertRaw("form_params:
+ custom_draft: true
+ custom_data: true
+ response_type: '200'
+ first_name: John
+ last_name: Smith");
+ $this->assertRaw('Processed draft request.');
+
+ // Login root user.
+ $this->drupalLogin($this->rootUser);
+
+ // Check 'convert' operation.
+ $this->assertRaw("form_params:
+ custom_converted: true
+ custom_data: true
+ first_name: John
+ last_name: Smith
+ response_type: '200'");
+ $this->assertRaw('Processed converted request.');
+
+ // Check excluded data.
+ $handler = $webform->getHandler('remote_post');
$configuration = $handler->getConfiguration();
$configuration['settings']['excluded_data'] = [
- 'subject' => 'subject',
- 'message' => 'message',
+ 'last_name' => 'last_name',
];
$handler->setConfiguration($configuration);
- $webform_handler_remote->save();
- $sid = $this->postSubmission($webform_handler_remote);
+ $webform->save();
+ $sid = $this->postSubmission($webform);
$this->assertRaw('first_name: John');
- $this->assertRaw('last_name: Smith');
- $this->assertRaw('email: from@example.com');
- $this->assertNoRaw("subject: '{subject}'");
- $this->assertNoRaw("message: '{message}'");
+ $this->assertNoRaw('last_name: Smith');
$this->assertRaw("sid: '$sid'");
- // @todo Figure out why the below test is failing on Drupal.org.
- // Check remote post 'create' 500 error handling.
- // $this->postSubmission($webform_handler_remote, ['first_name' => 'FAIL']);
- // $this->assertPattern('#\s+500#ms');
-
- // @todo Figure out why the below test is failing on Drupal.org.
- // Update the remote post handlers insert url to return a 404 error.
- // /** @var \Drupal\webform\Plugin\WebformHandler\RemotePostWebformHandler $handler */
- // $handler = $webform_handler_remote->getHandler('remote_post');
- // $configuration = $handler->getConfiguration();
- // $configuration['settings']['insert_url'] .= '/broken';
- // $handler->setConfiguration($configuration);
- // $webform_handler_remote->save();
-
- // $this->postSubmission($webform_handler_remote, ['first_name' => 'FAIL']);
- // $this->assertPattern('#\s+404#ms');
+ // Check 500 Internal Server Error.
+ $this->postSubmission($webform, ['response_type' => '500']);
+ $this->assertRaw('Failed to process completed request.');
+
+ // Check 404 Not Found.
+ $this->postSubmission($webform, ['response_type' => '404']);
+ $this->assertRaw('File not found');
+
+ // Disable saving of results
+ $webform->setSetting('results_disabled', TRUE);
+ $webform->save();
+
+ // Check confiramtion number when results disabled.
+ $sid = $this->postSubmission($webform);
+ $this->assertNull($sid);
+
+ // Get confiramtion number from JSON packet.
+ preg_match('/"confirmation_number":"([a-zA-z0-9]+)"/', $this->getRawContent(), $match);
+ $this->assertRaw('Your confirmation number is ' . $match[1] . '.');
}
}
diff --git a/src/Tests/WebformTestTrait.php b/src/Tests/WebformTestTrait.php
index cae2aec8..a836922c 100644
--- a/src/Tests/WebformTestTrait.php
+++ b/src/Tests/WebformTestTrait.php
@@ -141,10 +141,17 @@ trait WebformTestTrait {
/**
* Get the last submission id.
*
- * @return int
- * The last submission id.
+ * @param \Drupal\webform\WebformInterface $webform
+ * A webform.
+ *
+ * @return int|null
+ * The last submission id. NULL is saving of results is disabled.
*/
- protected function getLastSubmissionId($webform) {
+ protected function getLastSubmissionId(WebformInterface $webform) {
+ if ($webform->getSetting('results_disabled')) {
+ return NULL;
+ }
+
// Get submission sid.
$url = UrlHelper::parse($this->getUrl());
if (isset($url['query']['sid'])) {
diff --git a/src/WebformSubmissionInterface.php b/src/WebformSubmissionInterface.php
index 01020d4c..5d5926e5 100644
--- a/src/WebformSubmissionInterface.php
+++ b/src/WebformSubmissionInterface.php
@@ -227,7 +227,7 @@ interface WebformSubmissionInterface extends ContentEntityInterface, EntityOwner
/**
* Track the state of a submission.
*
- * @return int
+ * @return string
* Either STATE_NEW, STATE_DRAFT, STATE_COMPLETED, STATE_UPDATED, or
* STATE_CONVERTED depending on the last save operation performed.
*/
diff --git a/src/WebformSubmissionStorage.php b/src/WebformSubmissionStorage.php
index bcc040fc..f29e9619 100644
--- a/src/WebformSubmissionStorage.php
+++ b/src/WebformSubmissionStorage.php
@@ -131,7 +131,6 @@ class WebformSubmissionStorage extends SqlContentEntityStorage implements Webfor
parent::buildPropertyQuery($entity_query, $values);
}
-
/**
* {@inheritdoc}
*/
@@ -814,16 +813,14 @@ class WebformSubmissionStorage extends SqlContentEntityStorage implements Webfor
* {@inheritdoc}
*/
public function invokeWebformHandlers($method, WebformSubmissionInterface $webform_submission, &$context1 = NULL, &$context2 = NULL) {
- $webform = $webform_submission->getWebform();
- $webform->invokeHandlers($method, $webform_submission, $context1, $context2);
+ $webform_submission->invokeWebformHandlers($method, $webform_submission, $context1, $context2);
}
/**
* {@inheritdoc}
*/
public function invokeWebformElements($method, WebformSubmissionInterface $webform_submission, &$context1 = NULL, &$context2 = NULL) {
- $webform = $webform_submission->getWebform();
- $webform->invokeElements($method, $webform_submission, $context1, $context2);
+ $webform_submission->invokeWebformElements($method, $webform_submission, $context1, $context2);
}
/****************************************************************************/
@@ -881,64 +878,9 @@ class WebformSubmissionStorage extends SqlContentEntityStorage implements Webfor
/****************************************************************************/
/**
- * Save webform submission data from the 'webform_submission_data' table.
- *
- * @param array $webform_submissions
- * An array of webform submissions.
- */
- protected function loadData(array &$webform_submissions) {
- // Load webform submission data.
- if ($sids = array_keys($webform_submissions)) {
- /** @var \Drupal\Core\Database\StatementInterface $result */
- $result = $this->database->select('webform_submission_data', 'sd')
- ->fields('sd', ['webform_id', 'sid', 'name', 'property', 'delta', 'value'])
- ->condition('sd.sid', $sids, 'IN')
- ->orderBy('sd.sid', 'ASC')
- ->orderBy('sd.name', 'ASC')
- ->orderBy('sd.property', 'ASC')
- ->orderBy('sd.delta', 'ASC')
- ->execute();
- $submissions_data = [];
- while ($record = $result->fetchAssoc()) {
- $sid = $record['sid'];
- $name = $record['name'];
-
- $elements = $webform_submissions[$sid]->getWebform()->getElementsInitializedFlattenedAndHasValue();
- $element = (isset($elements[$name])) ? $elements[$name] : ['#webform_multiple' => FALSE, '#webform_composite' => FALSE];
-
- if ($element['#webform_composite']) {
- if ($element['#webform_multiple']) {
- $submissions_data[$sid][$name][$record['delta']][$record['property']] = $record['value'];
- }
- else {
- $submissions_data[$sid][$name][$record['property']] = $record['value'];
- }
- }
- elseif ($element['#webform_multiple']) {
- $submissions_data[$sid][$name][$record['delta']] = $record['value'];
- }
- else {
- $submissions_data[$sid][$name] = $record['value'];
- }
- }
-
- // Set webform submission data via setData().
- foreach ($submissions_data as $sid => $submission_data) {
- $webform_submissions[$sid]->setData($submission_data);
- $webform_submissions[$sid]->setOriginalData($submission_data);
- }
- }
- }
-
- /**
- * Save webform submission data to the 'webform_submission_data' table.
- *
- * @param \Drupal\webform\WebformSubmissionInterface $webform_submission
- * A webform submission.
- * @param bool $delete_first
- * TRUE to delete any data first. For new submissions this is not needed.
+ * {@inheritdoc}
*/
- protected function saveData(WebformSubmissionInterface $webform_submission, $delete_first = TRUE) {
+ public function saveData(WebformSubmissionInterface $webform_submission, $delete_first = TRUE) {
// Get submission data rows.
$data = $webform_submission->getData();
$webform_id = $webform_submission->getWebform()->id();
@@ -1010,6 +952,56 @@ class WebformSubmissionStorage extends SqlContentEntityStorage implements Webfor
}
/**
+ * Save webform submission data from the 'webform_submission_data' table.
+ *
+ * @param array $webform_submissions
+ * An array of webform submissions.
+ */
+ protected function loadData(array &$webform_submissions) {
+ // Load webform submission data.
+ if ($sids = array_keys($webform_submissions)) {
+ /** @var \Drupal\Core\Database\StatementInterface $result */
+ $result = $this->database->select('webform_submission_data', 'sd')
+ ->fields('sd', ['webform_id', 'sid', 'name', 'property', 'delta', 'value'])
+ ->condition('sd.sid', $sids, 'IN')
+ ->orderBy('sd.sid', 'ASC')
+ ->orderBy('sd.name', 'ASC')
+ ->orderBy('sd.property', 'ASC')
+ ->orderBy('sd.delta', 'ASC')
+ ->execute();
+ $submissions_data = [];
+ while ($record = $result->fetchAssoc()) {
+ $sid = $record['sid'];
+ $name = $record['name'];
+
+ $elements = $webform_submissions[$sid]->getWebform()->getElementsInitializedFlattenedAndHasValue();
+ $element = (isset($elements[$name])) ? $elements[$name] : ['#webform_multiple' => FALSE, '#webform_composite' => FALSE];
+
+ if ($element['#webform_composite']) {
+ if ($element['#webform_multiple']) {
+ $submissions_data[$sid][$name][$record['delta']][$record['property']] = $record['value'];
+ }
+ else {
+ $submissions_data[$sid][$name][$record['property']] = $record['value'];
+ }
+ }
+ elseif ($element['#webform_multiple']) {
+ $submissions_data[$sid][$name][$record['delta']] = $record['value'];
+ }
+ else {
+ $submissions_data[$sid][$name] = $record['value'];
+ }
+ }
+
+ // Set webform submission data via setData().
+ foreach ($submissions_data as $sid => $submission_data) {
+ $webform_submissions[$sid]->setData($submission_data);
+ $webform_submissions[$sid]->setOriginalData($submission_data);
+ }
+ }
+ }
+
+ /**
* Delete webform submission data from the 'webform_submission_data' table.
*
* @param array $webform_submissions
diff --git a/src/WebformSubmissionStorageInterface.php b/src/WebformSubmissionStorageInterface.php
index 58d69c53..24c127ea 100644
--- a/src/WebformSubmissionStorageInterface.php
+++ b/src/WebformSubmissionStorageInterface.php
@@ -395,6 +395,25 @@ interface WebformSubmissionStorageInterface extends ContentEntityStorageInterfac
public function purge($count);
/****************************************************************************/
+ // Data handlers.
+ /****************************************************************************/
+
+ /**
+ * Save webform submission data to the 'webform_submission_data' table.
+ *
+ * This method is public the allow webform handler (ie remote posts) to
+ * update [webform_handler] tokens stored in the submission data.
+ *
+ * @param \Drupal\webform\WebformSubmissionInterface $webform_submission
+ * A webform submission.
+ * @param bool $delete_first
+ * TRUE to delete any data first. For new submissions this is not needed.
+ *
+ * @see \Drupal\webform\Plugin\WebformHandler\RemotePostWebformHandler::remotePost
+ */
+ public function saveData(WebformSubmissionInterface $webform_submission, $delete_first = TRUE);
+
+ /****************************************************************************/
// Log methods.
/****************************************************************************/
diff --git a/src/WebformTokenManager.php b/src/WebformTokenManager.php
index 245a14e1..19063984 100644
--- a/src/WebformTokenManager.php
+++ b/src/WebformTokenManager.php
@@ -45,7 +45,7 @@ class WebformTokenManager implements WebformTokenManagerInterface {
// Replace tokens within an array.
if (is_array($text)) {
foreach ($text as $key => $value) {
- $text[$key] = $this->replace($value, $entity);
+ $text[$key] = $this->replace($value, $entity, $data, $options);
}
return $text;
}
@@ -70,7 +70,7 @@ class WebformTokenManager implements WebformTokenManagerInterface {
/**
* {@inheritdoc}
*/
- public function buildTreeLink(array $token_types = ['webform', 'webform_submission']) {
+ public function buildTreeLink(array $token_types = ['webform', 'webform_submission', 'webform_handler']) {
if ($this->moduleHandler->moduleExists('token')) {
// @todo Issue #2235581: Make Token Dialog support inserting in WYSIWYGs.
return [
diff --git a/templates/webform-handler-remote-post-summary.html.twig b/templates/webform-handler-remote-post-summary.html.twig
index b8bb8ecd..87c9298f 100644
--- a/templates/webform-handler-remote-post-summary.html.twig
+++ b/templates/webform-handler-remote-post-summary.html.twig
@@ -11,7 +11,10 @@
*/
#}
{% if settings.debug %}{{ 'Debugging is enabled'|t }}
{% endif %}
-{{ 'Insert URL:'|t }} {{ settings.insert_url }}
-{% if settings.update_url %}{{ 'Update URL:'|t }} {{ settings.update_url }}
{% endif %}
-{% if settings.delete_url %}{{ 'Delete URL:'|t }} {{ settings.delete_url }}
{% endif %}
+{{ 'Completed URL:'|t }} {{ settings.completed_url }}
+{% if settings.updated_url %}{{ 'Updated URL:'|t }} {{ settings.updated_url }}
{% endif %}
+{% if settings.deleted_url %}{{ 'Deleted URL:'|t }} {{ settings.deleted_url }}
{% endif %}
+{% if settings.draft_url %}{{ 'Draft URL:'|t }} {{ settings.draft_url }}
{% endif %}
+{% if settings.converted_url %}{{ 'Converted URL:'|t }} {{ settings.converted_url }}
{% endif %}
+
{{ 'Type:'|t }} {{ settings.type }}
diff --git a/tests/modules/webform_test_handler/src/Controller/WebformTestRemotePostController.php b/tests/modules/webform_test_handler/src/Controller/WebformTestRemotePostController.php
deleted file mode 100644
index 288cce7d..00000000
--- a/tests/modules/webform_test_handler/src/Controller/WebformTestRemotePostController.php
+++ /dev/null
@@ -1,43 +0,0 @@
-request->all();
- if (strpos(print_r($post_data, TRUE), 'FAIL') !== FALSE) {
- $json = [
- 'status' => 'fail',
- 'message' => (string) $this->t('Failed to process @type request.', ['@type' => $type]),
- ];
- return new JsonResponse($json, 500);
- }
- else {
- $json = [
- 'status' => 'success',
- 'message' => (string) $this->t('Processed @type request.', ['@type' => $type]),
- ];
- return new JsonResponse($json, 200);
- }
- }
-
-}
diff --git a/tests/modules/webform_test_handler/webform_test_handler.install b/tests/modules/webform_test_handler/webform_test_handler.install
deleted file mode 100644
index 741c9d68..00000000
--- a/tests/modules/webform_test_handler/webform_test_handler.install
+++ /dev/null
@@ -1,33 +0,0 @@
-getHandler('remote_post');
- $remote_post_configuration = $remote_post_handler->getConfiguration();
-
- // ISSUE: $base_url and $base_path are not working correctly so we are just
- // going to use the front page.
- $base_url = Url::fromRoute('', [], ['absolute' => TRUE])->toString();
- $remote_post_configuration['settings']['insert_url'] = $base_url . 'webform_test/remote_post/insert';
- $remote_post_configuration['settings']['update_url'] = $base_url . 'webform_test/remote_post/update';
- $remote_post_configuration['settings']['delete_url'] = $base_url . 'webform_test/remote_post/delete';
- $remote_post_handler->setConfiguration($remote_post_configuration);
-
- $remote_post_webform->save();
-}
diff --git a/tests/modules/webform_test_handler/webform_test_handler.routing.yml b/tests/modules/webform_test_handler/webform_test_handler.routing.yml
deleted file mode 100644
index be704133..00000000
--- a/tests/modules/webform_test_handler/webform_test_handler.routing.yml
+++ /dev/null
@@ -1,7 +0,0 @@
-webform_test_handler.remote_post:
- path: '/webform_test/remote_post/{type}'
- defaults:
- _controller: '\Drupal\webform_test_handler\Controller\WebformTestRemotePostController::index'
- requirements:
- # Remote post mock handler does not require any access controls.
- _access: 'TRUE'
diff --git a/tests/modules/webform_test_handler_remote_post/config/install/webform.webform.test_handler_remote_post.yml b/tests/modules/webform_test_handler_remote_post/config/install/webform.webform.test_handler_remote_post.yml
new file mode 100644
index 00000000..d59aa6e0
--- /dev/null
+++ b/tests/modules/webform_test_handler_remote_post/config/install/webform.webform.test_handler_remote_post.yml
@@ -0,0 +1,189 @@
+langcode: en
+status: open
+dependencies:
+ enforced:
+ module:
+ - webform_test_handler_remote_post
+open: null
+close: null
+uid: null
+template: false
+id: test_handler_remote_post
+title: 'Test: Handler: Remote post'
+description: 'Test remote post handler.'
+category: 'Test: Handler'
+elements: |
+ response_type:
+ '#title': 'Response type'
+ '#type': select
+ '#options':
+ 200: '200 OK'
+ 500: '500 Internal Server Error'
+ 404: '404 Not Found'
+ '#default_value': 200
+ first_name:
+ '#title': 'First name'
+ '#type': textfield
+ '#required': true
+ '#default_value': John
+ last_name:
+ '#title': 'Last name'
+ '#type': textfield
+ '#required': true
+ '#default_value': Smith
+ confirmation_number:
+ '#title': 'Confirmation number'
+ '#type': value
+ '#value': '[webform_handler:remote_post:completed:confirmation_number]'
+css: ''
+javascript: ''
+settings:
+ ajax: false
+ page: true
+ page_submit_path: ''
+ page_confirm_path: ''
+ form_submit_once: false
+ form_exception_message: ''
+ form_open_message: ''
+ form_close_message: ''
+ form_previous_submissions: true
+ form_confidential: false
+ form_confidential_message: ''
+ form_convert_anonymous: true
+ form_prepopulate: false
+ form_prepopulate_source_entity: false
+ form_prepopulate_source_entity_required: false
+ form_prepopulate_source_entity_type: ''
+ form_reset: false
+ form_disable_autocomplete: false
+ form_novalidate: false
+ form_unsaved: false
+ form_disable_back: false
+ form_autofocus: false
+ form_details_toggle: false
+ submission_label: ''
+ submission_log: false
+ submission_user_columns: { }
+ wizard_progress_bar: true
+ wizard_progress_pages: false
+ wizard_progress_percentage: false
+ wizard_start_label: ''
+ wizard_complete: true
+ wizard_complete_label: ''
+ preview: 0
+ preview_label: ''
+ preview_title: ''
+ preview_message: ''
+ preview_attributes: { }
+ preview_excluded_elements: { }
+ preview_exclude_empty: true
+ draft: all
+ draft_multiple: false
+ draft_auto_save: false
+ draft_saved_message: ''
+ draft_loaded_message: ''
+ confirmation_type: inline
+ confirmation_title: ''
+ confirmation_message: |
+ Your confirmation number is [webform-submission:values:confirmation_number].
+ confirmation_url: ''
+ confirmation_attributes: { }
+ confirmation_back: true
+ confirmation_back_label: ''
+ confirmation_back_attributes: { }
+ limit_total: null
+ limit_total_message: ''
+ limit_user: null
+ limit_user_message: ''
+ purge: none
+ purge_days: null
+ entity_limit_total: null
+ entity_limit_user: null
+ results_disabled: false
+ results_disabled_ignore: false
+ token_update: false
+access:
+ create:
+ roles:
+ - anonymous
+ - authenticated
+ users: { }
+ permissions: { }
+ view_any:
+ roles: { }
+ users: { }
+ permissions: { }
+ update_any:
+ roles: { }
+ users: { }
+ permissions: { }
+ delete_any:
+ roles: { }
+ users: { }
+ permissions: { }
+ purge_any:
+ roles: { }
+ users: { }
+ permissions: { }
+ view_own:
+ roles: { }
+ users: { }
+ permissions: { }
+ update_own:
+ roles: { }
+ users: { }
+ permissions: { }
+ delete_own:
+ roles: { }
+ users: { }
+ permissions: { }
+handlers:
+ remote_post:
+ id: remote_post
+ label: 'Remote post'
+ handler_id: remote_post
+ status: true
+ weight: 1
+ settings:
+ type: x-www-form-urlencoded
+ excluded_data:
+ serial: serial
+ sid: sid
+ uuid: uuid
+ token: token
+ uri: uri
+ created: created
+ completed: completed
+ changed: changed
+ in_draft: in_draft
+ current_page: current_page
+ remote_addr: remote_addr
+ uid: uid
+ langcode: langcode
+ webform_id: webform_id
+ entity_type: entity_type
+ entity_id: entity_id
+ sticky: sticky
+ notes: notes
+ confirmation_number: confirmation_number
+ custom_data: |
+ custom_data: true
+ custom_options: |
+ headers:
+ custom_header: 'true'
+ debug: true
+ completed_url: 'http://webform-test-handler-remote-post/completed'
+ completed_custom_data: |
+ custom_completed: true
+ updated_url: 'http://webform-test-handler-remote-post/updated'
+ updated_custom_data: |
+ custom_updated: true
+ deleted_url: 'http://webform-test-handler-remote-post/deleted'
+ deleted_custom_data: |
+ custom_deleted: true
+ draft_url: 'http://webform-test-handler-remote-post/draft'
+ draft_custom_data: |
+ custom_draft: true
+ converted_url: 'http://webform-test-handler-remote-post/converted'
+ converted_custom_data: |
+ custom_converted: true
diff --git a/tests/modules/webform_test_handler_remote_post/src/WebformTestHandlerRemotePostClient.php b/tests/modules/webform_test_handler_remote_post/src/WebformTestHandlerRemotePostClient.php
new file mode 100644
index 00000000..8bcc615b
--- /dev/null
+++ b/tests/modules/webform_test_handler_remote_post/src/WebformTestHandlerRemotePostClient.php
@@ -0,0 +1,60 @@
+['application/json']];
+ $json = [
+ 'status' => 'fail',
+ 'message' => (string) new FormattableMarkup('Failed to process @type request.', ['@type' => $operation]),
+ 'options' => $options,
+ ];
+ return new Response($status, $headers, Json::encode($json));
+
+ // 200 OK.
+ case 200:
+ default:
+ $status = 200;
+ $headers = ['Content-Type' =>['application/json']];
+ $json = [
+ 'status' => 'success',
+ 'message' => (string) new FormattableMarkup('Processed @type request.', ['@type' => $operation]),
+ 'options' => $options,
+ 'confirmation_number' => $random->name(20, TRUE),
+ ];
+ return new Response($status, $headers, Json::encode($json));
+ }
+ }
+
+}
diff --git a/tests/modules/webform_test_handler_remote_post/src/WebformTestHandlerRemotePostClientFactory.php b/tests/modules/webform_test_handler_remote_post/src/WebformTestHandlerRemotePostClientFactory.php
new file mode 100644
index 00000000..aa7bf4ff
--- /dev/null
+++ b/tests/modules/webform_test_handler_remote_post/src/WebformTestHandlerRemotePostClientFactory.php
@@ -0,0 +1,37 @@
+ TRUE,
+ 'timeout' => 30,
+ 'headers' => [
+ 'User-Agent' => 'Drupal/' . \Drupal::VERSION . ' (+https://www.drupal.org/) ' . \GuzzleHttp\default_user_agent(),
+ ],
+ 'handler' => $this->stack,
+ 'proxy' => [
+ 'http' => NULL,
+ 'https' => NULL,
+ 'no' => [],
+ ]
+ ];
+ $config = NestedArray::mergeDeep($default_config, Settings::get('http_client_config', []), $config);
+ return new WebformTestHandlerRemotePostClient($config);
+ }
+
+}
diff --git a/tests/modules/webform_test_handler_remote_post/src/WebformTestHandlerRemotePostServiceProvider.php b/tests/modules/webform_test_handler_remote_post/src/WebformTestHandlerRemotePostServiceProvider.php
new file mode 100755
index 00000000..d549c660
--- /dev/null
+++ b/tests/modules/webform_test_handler_remote_post/src/WebformTestHandlerRemotePostServiceProvider.php
@@ -0,0 +1,21 @@
+getDefinition('http_client_factory');
+ $definition->setClass('Drupal\webform_test_handler_remote_post\WebformTestHandlerRemotePostClientFactory');
+ }
+
+}
diff --git a/tests/modules/webform_test_handler_remote_post/webform_test_handler_remote_post.features.yml b/tests/modules/webform_test_handler_remote_post/webform_test_handler_remote_post.features.yml
new file mode 100644
index 00000000..f32a5804
--- /dev/null
+++ b/tests/modules/webform_test_handler_remote_post/webform_test_handler_remote_post.features.yml
@@ -0,0 +1 @@
+true
\ No newline at end of file
diff --git a/tests/modules/webform_test_handler_remote_post/webform_test_handler_remote_post.info.yml b/tests/modules/webform_test_handler_remote_post/webform_test_handler_remote_post.info.yml
new file mode 100644
index 00000000..1a36a80b
--- /dev/null
+++ b/tests/modules/webform_test_handler_remote_post/webform_test_handler_remote_post.info.yml
@@ -0,0 +1,7 @@
+name: 'Webform module remote post tests'
+type: module
+description: 'Support module for Webform module remote post testing.'
+package: Testing
+core: 8.x
+dependencies:
+ - 'drupal:webform'
diff --git a/webform.install b/webform.install
index 17c29e02..eb892b3b 100644
--- a/webform.install
+++ b/webform.install
@@ -1029,3 +1029,41 @@ function webform_update_8070() {
_webform_update_admin_settings();
}
+/**
+ * Issue #2898424: Improve Remote Post.
+ */
+function webform_update_8071() {
+ $settings_mapping = [
+ 'insert_url' => 'completed_url',
+ 'insert_custom_data' => 'completed_custom_data',
+ 'update_url' => 'updated_url',
+ 'update_custom_data' => 'updated_custom_data',
+ 'delete_url' => 'deleted_url',
+ 'delete_custom_data' => 'deleted_custom_data',
+ ];
+
+ /** @var \Drupal\webform\WebformInterface[] $webforms */
+ $webforms = Webform::loadMultiple();
+ foreach ($webforms as $webform) {
+ $has_remote_post = FALSE;
+ $handlers = $webform->getHandlers();
+ foreach ($handlers as $handler) {
+ if ($handler instanceof \Drupal\webform\Plugin\WebformHandler\RemotePostWebformHandler) {
+ $has_remote_post = TRUE;
+ $configuration = $handler->getConfiguration();
+ foreach ($configuration['settings'] as $key => $value) {
+ if (isset($settings_mapping[$key])) {
+ $configuration['settings'][$settings_mapping[$key]] = $value;
+ unset($configuration['settings'][$key]);
+ }
+ }
+ $configuration['settings'] += $handler->defaultConfiguration();
+ $handler->setConfiguration($configuration);
+ }
+ }
+ if ($has_remote_post) {
+ $webform->save();
+ }
+ }
+
+}
diff --git a/webform.tokens.inc b/webform.tokens.inc
index edc02994..a85985b1 100644
--- a/webform.tokens.inc
+++ b/webform.tokens.inc
@@ -5,10 +5,11 @@
* Builds placeholder replacement tokens for webforms and submissions.
*/
-use Drupal\Core\Render\Markup;
+use Drupal\Component\Utility\NestedArray;
use Drupal\Component\Render\MarkupInterface;
use Drupal\Core\Datetime\Entity\DateFormat;
use Drupal\Core\Render\BubbleableMetadata;
+use Drupal\Core\Render\Markup;
use Drupal\user\Entity\User;
use Drupal\webform\Utility\WebformDateHelper;
use Drupal\webform\Plugin\WebformElementManagerInterface;
@@ -241,7 +242,7 @@ function webform_token_info() {
$tokens['webform'] = $webform;
/****************************************************************************/
- // Webform.
+ // Webform role.
/****************************************************************************/
$roles = \Drupal::config('webform.settings')->get('mail.roles');
@@ -268,6 +269,32 @@ function webform_token_info() {
}
/****************************************************************************/
+ // Webform handler.
+ /****************************************************************************/
+
+ $types['webform_handler'] = [
+ 'name' => t('Webform handler'),
+ 'description' => t('Tokens related to the current webform handler.'),
+ 'needs-data' => 'webform_handler',
+ ];
+
+ $webform_handler = [];
+ $webform_handler['id'] = [
+ 'name' => t('Webform handler ID'),
+ 'description' => Markup::create((string) t('Webform handler response tokens.') . '
' .
+ t("Replace the 'id:?' with...") . '
' .
+ '' .
+ '- webform_handler_id:state:key
' .
+ '- webform_handler_id:state:key1:key2
' .
+ '
' .
+ t("For example, to display a remote post's confirmation number you would use the [webform_handler:remote_post:completed:confirmation_number] token.")
+ ),
+ 'dynamic' => TRUE,
+ ];
+
+ $tokens['webform_handler'] = $webform_handler;
+
+ /****************************************************************************/
return ['types' => $types, 'tokens' => $tokens];
}
@@ -333,6 +360,22 @@ function webform_tokens($type, $tokens, array $data, array $options, BubbleableM
}
}
+ elseif ($type == 'webform_handler') {
+ if (isset($data['webform_handler'])) {
+ $webform_handler = $data['webform_handler'];
+ foreach ($tokens as $name => $original) {
+ $parents = explode(':', $name);
+ $value = NestedArray::getValue($webform_handler, $parents, $key_exists);
+ $replacements[$original] = ($key_exists) ? $value : $original;
+ }
+ }
+ else {
+ // Preserve all [webform_handler] tokens.
+ foreach ($tokens as $name => $original) {
+ $replacements[$original] = $original;
+ }
+ }
+ }
elseif ($type == 'webform_submission' && !empty($data['webform_submission'])) {
/** @var \Drupal\webform\Plugin\WebformElementManagerInterface $element_manager */
$element_manager = \Drupal::service('plugin.manager.webform.element');