diff --git a/core/modules/config_translation/src/Tests/ConfigTranslationUiTest.php b/core/modules/config_translation/src/Tests/ConfigTranslationUiTest.php index a718808..6c3711d 100644 --- a/core/modules/config_translation/src/Tests/ConfigTranslationUiTest.php +++ b/core/modules/config_translation/src/Tests/ConfigTranslationUiTest.php @@ -284,6 +284,7 @@ public function testContactConfigEntityTranslation() { 'label' => $label, 'recipients' => 'sales@example.com,support@example.com', 'reply' => 'Thank you for your mail', + 'redirect' => '/user' ); $this->drupalPostForm('admin/structure/contact/manage/feedback', $edit, t('Save')); diff --git a/core/modules/contact/config/install/contact.form.personal.yml b/core/modules/contact/config/install/contact.form.personal.yml index c766fdd..a161a3c 100644 --- a/core/modules/contact/config/install/contact.form.personal.yml +++ b/core/modules/contact/config/install/contact.form.personal.yml @@ -6,3 +6,5 @@ label: 'Personal contact form' recipients: { } reply: '' weight: 0 +message: 'Your message has been sent.' +redirect: '/' diff --git a/core/modules/contact/config/schema/contact.schema.yml b/core/modules/contact/config/schema/contact.schema.yml index 5a62e9d..77cfc18 100644 --- a/core/modules/contact/config/schema/contact.schema.yml +++ b/core/modules/contact/config/schema/contact.schema.yml @@ -22,6 +22,12 @@ contact.form.*: weight: type: integer label: 'Weight' + message: + type: label + label: 'Message' + redirect: + type: path + label: 'Redirect Path' contact.settings: type: config_object diff --git a/core/modules/contact/contact.install b/core/modules/contact/contact.install new file mode 100644 index 0000000..c1ecc15 --- /dev/null +++ b/core/modules/contact/contact.install @@ -0,0 +1,18 @@ +getStorage('contact_form')->loadMultiple(); + foreach($entities as $contact) { + $contact->setMessage('Your message has been sent.'); + $contact->setRedirectPath('/'); + } +} diff --git a/core/modules/contact/src/ContactFormEditForm.php b/core/modules/contact/src/ContactFormEditForm.php index b4adde6..86027c3 100644 --- a/core/modules/contact/src/ContactFormEditForm.php +++ b/core/modules/contact/src/ContactFormEditForm.php @@ -14,6 +14,7 @@ use Drupal\Core\Form\ConfigFormBaseTrait; use Drupal\Core\Form\FormStateInterface; use Egulias\EmailValidator\EmailValidator; +use Drupal\Core\Render\Element\PathElement; /** * Base form for contact form edit forms. @@ -80,6 +81,12 @@ public function form(array $form, FormStateInterface $form_state) { ), '#disabled' => !$contact_form->isNew(), ); + $form['message'] = array( + '#type' => 'textarea', + '#title' => $this->t('Message'), + '#default_value' => $contact_form->getMessage(), + '#description' => $this->t('The message to display to the user after submission of this form. Leave blank for no message.'), + ); $form['recipients'] = array( '#type' => 'textarea', '#title' => $this->t('Recipients'), @@ -87,6 +94,13 @@ public function form(array $form, FormStateInterface $form_state) { '#description' => $this->t("Example: 'webmaster@example.com' or 'sales@example.com,support@example.com' . To specify multiple recipients, separate each email address with a comma."), '#required' => TRUE, ); + $form['redirect'] = array( + '#type' => 'path', + '#title' => $this->t('Redirect path'), + '#convert_path' => PathElement::CONVERT_NONE, + '#default_value' => $contact_form->getRedirectPath(), + '#description' => $this->t('The path you would like to redirect to after this form has been submitted. Enter to direct to front page.'), + ); $form['reply'] = array( '#type' => 'textarea', '#title' => $this->t('Auto-reply'), diff --git a/core/modules/contact/src/ContactFormInterface.php b/core/modules/contact/src/ContactFormInterface.php index 8f588ee..063553b 100644 --- a/core/modules/contact/src/ContactFormInterface.php +++ b/core/modules/contact/src/ContactFormInterface.php @@ -8,6 +8,7 @@ namespace Drupal\contact; use Drupal\Core\Config\Entity\ConfigEntityInterface; +use Drupal\Core\Url; /** * Provides an interface defining a contact form entity. @@ -15,6 +16,14 @@ interface ContactFormInterface extends ConfigEntityInterface { /** + * Returns the message to be displayed to user. + * + * @return string + * A user message. + */ + public function getMessage(); + + /** * Returns list of recipient email addresses. * * @return array @@ -26,11 +35,27 @@ public function getRecipients(); * Returns an auto-reply message to send to the message author. * * @return string - * An auto-reply message + * An auto-reply message. */ public function getReply(); /** + * Returns the path for redirect. + * + * @return string + * The redirect path + */ + public function getRedirectPath(); + + /** + * Returns the url for redirect. + * + * @return \Drupal\core\Url + * The redirect URL + */ + public function getRedirectUrl(); + + /** * Returns the weight of this category (used for sorting). * * @return int @@ -39,6 +64,16 @@ public function getReply(); public function getWeight(); /** + * Sets the message to be displayed to the user. + * + * @param string $message + * The message to display after form is submitted. + * + * @return $this + */ + public function setMessage($message); + + /** * Sets list of recipient email addresses. * * @param array $recipients @@ -59,6 +94,16 @@ public function setRecipients($recipients); public function setReply($reply); /** + * Sets the redirect path. + * + * @param string $redirect + * The desired path. + * + * @return $this + */ + public function setRedirectPath($redirect); + + /** * Sets the weight. * * @param int $weight diff --git a/core/modules/contact/src/Entity/ContactForm.php b/core/modules/contact/src/Entity/ContactForm.php index 1a9f73a..4fbc1e3 100644 --- a/core/modules/contact/src/Entity/ContactForm.php +++ b/core/modules/contact/src/Entity/ContactForm.php @@ -9,6 +9,7 @@ use Drupal\Core\Config\Entity\ConfigEntityBundleBase; use Drupal\contact\ContactFormInterface; +use Drupal\Core\Url; /** * Defines the contact form entity. @@ -44,6 +45,8 @@ * "recipients", * "reply", * "weight", + * "message", + * "redirect", * } * ) */ @@ -64,6 +67,13 @@ class ContactForm extends ConfigEntityBundleBase implements ContactFormInterface protected $label; /** + * The message displayed to user. + * + * @var string + */ + protected $message; + + /** * List of recipient email addresses. * * @var array @@ -71,6 +81,13 @@ class ContactForm extends ConfigEntityBundleBase implements ContactFormInterface protected $recipients = array(); /** + * The path to redirect to. + * + * @var string + */ + protected $redirect; + + /** * An auto-reply message. * * @var string @@ -87,6 +104,13 @@ class ContactForm extends ConfigEntityBundleBase implements ContactFormInterface /** * {@inheritdoc} */ + public function getMessage() { + return $this->get('message'); + } + + /** + * {@inheritdoc} + */ public function getRecipients() { return $this->recipients; } @@ -109,6 +133,31 @@ public function getReply() { /** * {@inheritdoc} */ + public function getRedirectPath() { + return $this->redirect; + } + + /** + * {@inheritdoc} + */ + public function getRedirectUrl() { + $this->redirect = $this->redirect ? $this->redirect : '/'; + /** @var \Drupal\Core\Url $url */ + $url = Url::fromUserInput($this->redirect); + return $url; + } + + /** + * {@inheritdoc} + */ + public function setMessage($message) { + $this->set('message', $message); + return $this; + } + + /** + * {@inheritdoc} + */ public function setReply($reply) { $this->reply = $reply; return $this; @@ -124,6 +173,14 @@ public function getWeight() { /** * {@inheritdoc} */ + public function setRedirectPath($redirect) { + $this->set('redirect', $redirect); + return $this; + } + + /** + * {@inheritdoc} + */ public function setWeight($weight) { $this->weight = $weight; return $this; diff --git a/core/modules/contact/src/MessageForm.php b/core/modules/contact/src/MessageForm.php index 46bb5d9..e7510a3 100644 --- a/core/modules/contact/src/MessageForm.php +++ b/core/modules/contact/src/MessageForm.php @@ -211,9 +211,12 @@ public function save(array $form, FormStateInterface $form_state) { $message = $this->entity; $user = $this->currentUser(); $this->mailHandler->sendMailMessages($message, $user); + $contact_form = $message->getContactForm(); $this->flood->register('contact', $this->config('contact.settings')->get('flood.interval')); - drupal_set_message($this->t('Your message has been sent.')); + if ($contact_message = $contact_form->getMessage()) { + drupal_set_message($contact_message); + } // To avoid false error messages caused by flood control, redirect away from // the contact form; either to the contacted user account or the front page. @@ -221,12 +224,13 @@ public function save(array $form, FormStateInterface $form_state) { $form_state->setRedirectUrl($message->getPersonalRecipient()->urlInfo()); } else { - $form_state->setRedirect(''); + $form_state->setRedirectUrl($contact_form->getRedirectUrl()); } // Save the message. In core this is a no-op but should contrib wish to // implement message storage, this will make the task of swapping in a real // storage controller straight-forward. $message->save(); + } } diff --git a/core/modules/contact/src/Tests/ContactSitewideTest.php b/core/modules/contact/src/Tests/ContactSitewideTest.php index 39cd34a..3d4008e 100644 --- a/core/modules/contact/src/Tests/ContactSitewideTest.php +++ b/core/modules/contact/src/Tests/ContactSitewideTest.php @@ -10,6 +10,7 @@ use Drupal\Component\Utility\Unicode; use Drupal\contact\Entity\ContactForm; use Drupal\Core\Mail\MailFormatHelper; +use Drupal\Core\Url; use Drupal\field_ui\Tests\FieldUiTestTrait; use Drupal\simpletest\WebTestBase; use Drupal\Core\Entity\EntityTypeInterface; @@ -151,7 +152,7 @@ function testSiteWideContact() { $this->assertEscaped($recipients[0]); // Test update contact form. - $this->updateContactForm($id, $label = $this->randomMachineName(16), $recipients_str = implode(',', array($recipients[0], $recipients[1])), $reply = $this->randomMachineName(30), FALSE); + $this->updateContactForm($id, $label = $this->randomMachineName(16), $recipients_str = implode(',', array($recipients[0], $recipients[1])), $reply = $this->randomMachineName(30), FALSE, 'Your message has been sent.', '/user'); $config = $this->config('contact.form.' . $id)->get(); $this->assertEqual($config['label'], $label); $this->assertEqual($config['recipients'], array($recipients[0], $recipients[1])); @@ -299,6 +300,25 @@ function testSiteWideContact() { $this->assertEqual($mail['subject'], t('[@label] @subject', array('@label' => $label, '@subject' => $edit['subject[0][value]']))); $this->assertTrue(strpos($mail['body'], $field_label)); $this->assertTrue(strpos($mail['body'], $edit[$field_name . '[0][value]'])); + + // Test messages and redirect. + /** @var \Drupal\contact\ContactFormInterface $form */ + $form = ContactForm::load($contact_form); + $form->setMessage('Thanks for your submission'); + $form->setRedirectPath('/user/' . $admin_user->id()); + $form->save(); + // Check that the field is displayed. + $this->drupalGet('contact/' . $contact_form); + + // Submit the contact form and verify the content. + $edit = array( + 'subject[0][value]' => $this->randomMachineName(), + 'message[0][value]' => $this->randomMachineName(), + $field_name . '[0][value]' => $this->randomMachineName(), + ); + $this->drupalPostForm(NULL, $edit, t('Send message')); + $this->assertText('Thanks for your submission'); + $this->assertUrl('user/' . $admin_user->id()); } /** @@ -360,13 +380,17 @@ function testAutoReply() { * form. * @param bool $selected * A Boolean indicating whether the form should be selected by default. + * @param string $message + * The message that will be displayed to a user upon completing the contact + * form. * @param array $third_party_settings * Array of third party settings to be added to the posted form data. */ - function addContactForm($id, $label, $recipients, $reply, $selected, $third_party_settings = []) { + function addContactForm($id, $label, $recipients, $reply, $selected, $message = 'Your message has been sent.', $third_party_settings = []) { $edit = array(); $edit['label'] = $label; $edit['id'] = $id; + $edit['message'] = $message; $edit['recipients'] = $recipients; $edit['reply'] = $reply; $edit['selected'] = ($selected ? TRUE : FALSE); @@ -388,13 +412,20 @@ function addContactForm($id, $label, $recipients, $reply, $selected, $third_part * form. * @param bool $selected * A Boolean indicating whether the form should be selected by default. + * @param string $message + * The message that will be displayed to a user upon completing the contact + * form. + * @param string $redirect + * The path where user will be redirect after this form has been submitted.. */ - function updateContactForm($id, $label, $recipients, $reply, $selected) { + function updateContactForm($id, $label, $recipients, $reply, $selected, $message = 'Your message has been sent.', $redirect = '/') { $edit = array(); $edit['label'] = $label; $edit['recipients'] = $recipients; $edit['reply'] = $reply; $edit['selected'] = ($selected ? TRUE : FALSE); + $edit['message'] = $message; + $edit['redirect'] = $redirect; $this->drupalPostForm("admin/structure/contact/manage/$id", $edit, t('Save')); } diff --git a/core/modules/contact/src/Tests/ContactStorageTest.php b/core/modules/contact/src/Tests/ContactStorageTest.php index f18d10e..477b2bd 100644 --- a/core/modules/contact/src/Tests/ContactStorageTest.php +++ b/core/modules/contact/src/Tests/ContactStorageTest.php @@ -52,9 +52,7 @@ public function testContactStorage() { $this->drupalLogin($admin_user); // Create first valid contact form. $mail = 'simpletest@example.com'; - $this->addContactForm($id = Unicode::strtolower($this->randomMachineName(16)), $label = $this->randomMachineName(16), implode(',', array($mail)), '', TRUE, [ - 'send_a_pony' => 1, - ]); + $this->addContactForm($id = Unicode::strtolower($this->randomMachineName(16)), $label = $this->randomMachineName(16), implode(',', array($mail)), '', TRUE, 'Your message has been sent.', ['send_a_pony' => 1]); $this->assertRaw(t('Contact form %label has been added.', array('%label' => $label))); // Ensure that anonymous can submit site-wide contact form. diff --git a/core/modules/contact/tests/modules/contact_test/config/install/contact.form.feedback.yml b/core/modules/contact/tests/modules/contact_test/config/install/contact.form.feedback.yml index 8fb7765..b284711 100644 --- a/core/modules/contact/tests/modules/contact_test/config/install/contact.form.feedback.yml +++ b/core/modules/contact/tests/modules/contact_test/config/install/contact.form.feedback.yml @@ -5,3 +5,5 @@ reply: '' weight: 0 status: true langcode: en +message: 'Your message has been sent.' +redirectn: '/' diff --git a/core/profiles/standard/config/install/contact.form.feedback.yml b/core/profiles/standard/config/install/contact.form.feedback.yml index 47f0e90..94e2a9a 100644 --- a/core/profiles/standard/config/install/contact.form.feedback.yml +++ b/core/profiles/standard/config/install/contact.form.feedback.yml @@ -7,3 +7,5 @@ recipients: - admin@example.com reply: '' weight: 0 +message: 'Your message has been sent.' +redirect: '/'