Version 1
[yaffs-website] / web / core / modules / system / src / Tests / Form / TriggeringElementTest.php
diff --git a/web/core/modules/system/src/Tests/Form/TriggeringElementTest.php b/web/core/modules/system/src/Tests/Form/TriggeringElementTest.php
new file mode 100644 (file)
index 0000000..973d37d
--- /dev/null
@@ -0,0 +1,97 @@
+<?php
+
+namespace Drupal\system\Tests\Form;
+
+use Drupal\simpletest\WebTestBase;
+
+/**
+ * Tests that FAPI correctly determines the triggering element.
+ *
+ * @group Form
+ */
+class TriggeringElementTest extends WebTestBase {
+
+  /**
+   * Modules to enable.
+   *
+   * @var array
+   */
+  public static $modules = ['form_test'];
+
+  /**
+   * Test the determination of the triggering element when no button
+   * information is included in the POST data, as is sometimes the case when
+   * the ENTER key is pressed in a textfield in Internet Explorer.
+   */
+  public function testNoButtonInfoInPost() {
+    $path = 'form-test/clicked-button';
+    $edit = [];
+    $form_html_id = 'form-test-clicked-button';
+
+    // Ensure submitting a form with no buttons results in no triggering element
+    // and the form submit handler not running.
+    $this->drupalPostForm($path, $edit, NULL, [], [], $form_html_id);
+    $this->assertText('There is no clicked button.', '$form_state->getTriggeringElement() set to NULL.');
+    $this->assertNoText('Submit handler for form_test_clicked_button executed.', 'Form submit handler did not execute.');
+
+    // Ensure submitting a form with one or more submit buttons results in the
+    // triggering element being set to the first one the user has access to. An
+    // argument with 'r' in it indicates a restricted (#access=FALSE) button.
+    $this->drupalPostForm($path . '/s', $edit, NULL, [], [], $form_html_id);
+    $this->assertText('The clicked button is button1.', '$form_state->getTriggeringElement() set to only button.');
+    $this->assertText('Submit handler for form_test_clicked_button executed.', 'Form submit handler executed.');
+
+    $this->drupalPostForm($path . '/s/s', $edit, NULL, [], [], $form_html_id);
+    $this->assertText('The clicked button is button1.', '$form_state->getTriggeringElement() set to first button.');
+    $this->assertText('Submit handler for form_test_clicked_button executed.', 'Form submit handler executed.');
+
+    $this->drupalPostForm($path . '/rs/s', $edit, NULL, [], [], $form_html_id);
+    $this->assertText('The clicked button is button2.', '$form_state->getTriggeringElement() set to first available button.');
+    $this->assertText('Submit handler for form_test_clicked_button executed.', 'Form submit handler executed.');
+
+    // Ensure submitting a form with buttons of different types results in the
+    // triggering element being set to the first button, regardless of type. For
+    // the FAPI 'button' type, this should result in the submit handler not
+    // executing. The types are 's'(ubmit), 'b'(utton), and 'i'(mage_button).
+    $this->drupalPostForm($path . '/s/b/i', $edit, NULL, [], [], $form_html_id);
+    $this->assertText('The clicked button is button1.', '$form_state->getTriggeringElement() set to first button.');
+    $this->assertText('Submit handler for form_test_clicked_button executed.', 'Form submit handler executed.');
+
+    $this->drupalPostForm($path . '/b/s/i', $edit, NULL, [], [], $form_html_id);
+    $this->assertText('The clicked button is button1.', '$form_state->getTriggeringElement() set to first button.');
+    $this->assertNoText('Submit handler for form_test_clicked_button executed.', 'Form submit handler did not execute.');
+
+    $this->drupalPostForm($path . '/i/s/b', $edit, NULL, [], [], $form_html_id);
+    $this->assertText('The clicked button is button1.', '$form_state->getTriggeringElement() set to first button.');
+    $this->assertText('Submit handler for form_test_clicked_button executed.', 'Form submit handler executed.');
+  }
+
+  /**
+   * Test that the triggering element does not get set to a button with
+   * #access=FALSE.
+   */
+  public function testAttemptAccessControlBypass() {
+    $path = 'form-test/clicked-button';
+    $form_html_id = 'form-test-clicked-button';
+
+    // Retrieve a form where 'button1' has #access=FALSE and 'button2' doesn't.
+    $this->drupalGet($path . '/rs/s');
+
+    // Submit the form with 'button1=button1' in the POST data, which someone
+    // trying to get around security safeguards could easily do. We have to do
+    // a little trickery here, to work around the safeguards in drupalPostForm(): by
+    // renaming the text field that is in the form to 'button1', we can get the
+    // data we want into \Drupal::request()->request.
+    $elements = $this->xpath('//form[@id="' . $form_html_id . '"]//input[@name="text"]');
+    $elements[0]['name'] = 'button1';
+    $this->drupalPostForm(NULL, ['button1' => 'button1'], NULL, [], [], $form_html_id);
+
+    // Ensure that the triggering element was not set to the restricted button.
+    // Do this with both a negative and positive assertion, because negative
+    // assertions alone can be brittle. See testNoButtonInfoInPost() for why the
+    //triggering element gets set to 'button2'.
+    $this->assertNoText('The clicked button is button1.', '$form_state->getTriggeringElement() not set to a restricted button.');
+    $this->assertText('The clicked button is button2.', '$form_state->getTriggeringElement() not set to a restricted button.');
+  }
+
+}