bug symfony#9328 [2.3][Form] Changed FormTypeCsrfExtension to use the form's name as default intention (bschussek)

This PR was merged into the 2.3 branch. Discussion ---------- [2.3][Form] Changed FormTypeCsrfExtension to use the form's name as default intention Equivalent of symfony#9327, merged into 2.3. Commits ------- c4abe83 Merge branch 'fix-csrf-default-2.2' into fix-csrf-default-2.3 b07c618 [Form] Changed FormTypeCsrfExtension to use the form's name as default intention

Author: fabpot

src/Symfony/Component/Form/Extension/Csrf/Type/FormTypeCsrfExtension.php

@@ -76,7 +76,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
  ->addEventSubscriber(new CsrfValidationListener(
  $options['csrf_field_name'],
  $options['csrf_provider'],
- $options['intention'],
+ $options['intention'] ?: $builder->getName(),
  $options['csrf_message'],
  $this->translator,
  $this->translationDomain
@@ -95,7 +95,7 @@ public function finishView(FormView $view, FormInterface $form, array $options)
  {
  if ($options['csrf_protection'] && !$view->parent && $options['compound']) {
  $factory = $form->getConfig()->getAttribute('csrf_factory');
- $data = $options['csrf_provider']->generateCsrfToken($options['intention']);
+ $data = $options['csrf_provider']->generateCsrfToken($options['intention'] ?: $form->getName());
 
  $csrfForm = $factory->createNamed($options['csrf_field_name'], 'hidden', $data, array(
  'mapped' => false,
@@ -115,7 +115,7 @@ public function setDefaultOptions(OptionsResolverInterface $resolver)
  'csrf_field_name' => $this->defaultFieldName,
  'csrf_provider' => $this->defaultCsrfProvider,
  'csrf_message' => 'The CSRF token is invalid. Please try to resubmit the form.',
- 'intention' => 'unknown',
+ 'intention' => null,
  ));
  }
 

src/Symfony/Component/Form/Tests/Extension/Csrf/Type/FormTypeCsrfExtensionTest.php

@@ -140,6 +140,24 @@ public function testGenerateCsrfToken()
  $this->assertEquals('token', $view['csrf']->vars['value']);
  }
 
+ public function testGenerateCsrfTokenUsesFormNameAsIntentionByDefault()
+ {
+ $this->csrfProvider->expects($this->once())
+ ->method('generateCsrfToken')
+ ->with('FORM_NAME')
+ ->will($this->returnValue('token'));
+
+ $view = $this->factory
+ ->createNamed('FORM_NAME', 'form', null, array(
+ 'csrf_field_name' => 'csrf',
+ 'csrf_provider' => $this->csrfProvider,
+ 'compound' => true,
+ ))
+ ->createView();
+
+ $this->assertEquals('token', $view['csrf']->vars['value']);
+ }
+
  public function provideBoolean()
  {
  return array(
@@ -180,6 +198,37 @@ public function testValidateTokenOnSubmitIfRootAndCompound($valid)
  $this->assertSame($valid, $form->isValid());
  }
 
+ /**
+ * @dataProvider provideBoolean
+ */
+ public function testValidateTokenOnBindIfRootAndCompoundUsesFormNameAsIntentionByDefault($valid)
+ {
+ $this->csrfProvider->expects($this->once())
+ ->method('isCsrfTokenValid')
+ ->with('FORM_NAME', 'token')
+ ->will($this->returnValue($valid));
+
+ $form = $this->factory
+ ->createNamedBuilder('FORM_NAME', 'form', null, array(
+ 'csrf_field_name' => 'csrf',
+ 'csrf_provider' => $this->csrfProvider,
+ 'compound' => true,
+ ))
+ ->add('child', 'text')
+ ->getForm();
+
+ $form->submit(array(
+ 'child' => 'foobar',
+ 'csrf' => 'token',
+ ));
+
+ // Remove token from data
+ $this->assertSame(array('child' => 'foobar'), $form->getData());
+
+ // Validate accordingly
+ $this->assertSame($valid, $form->isValid());
+ }
+
  public function testFailIfRootAndCompoundAndTokenMissing()
  {
  $this->csrfProvider->expects($this->never())