WIP - lets pick the correct password encoder to use

Author: jrushlow

src/Generator.php

@@ -15,6 +15,8 @@
 use Symfony\Bundle\MakerBundle\Exception\RuntimeCommandException;
 use Symfony\Bundle\MakerBundle\Util\ClassNameDetails;
 use Symfony\Bundle\MakerBundle\Util\PhpCompatUtil;
+use Symfony\Bundle\MakerBundle\Util\TemplateClassDetails;
+use Symfony\Bundle\MakerBundle\Util\TemplateClassFormatter;
 
 /**
  * @author Javier Eguiluz <[email protected]>
@@ -26,9 +28,10 @@ class Generator
     private $twigHelper;
     private $pendingOperations = [];
     private $namespacePrefix;
+    private $templateClassFormatter;
     private $phpCompatUtil;
 
-    public function __construct(FileManager $fileManager, string $namespacePrefix, PhpCompatUtil $phpCompatUtil = null)
+    public function __construct(FileManager $fileManager, string $namespacePrefix, PhpCompatUtil $phpCompatUtil = null, TemplateClassFormatter $templateClassFormatter = null)
     {
         $this->fileManager = $fileManager;
         $this->twigHelper = new GeneratorTwigHelper($fileManager);
@@ -41,6 +44,14 @@ public function __construct(FileManager $fileManager, string $namespacePrefix, P
         }
 
         $this->phpCompatUtil = $phpCompatUtil;
+
+        if (null === $phpCompatUtil) {
+            $templateClassFormatter = new TemplateClassFormatter($this->phpCompatUtil);
+
+//            trigger_deprecation('symfony/maker-bundle', '1.25', 'Initializing Generator without providing an instance of PhpCompatUtil is deprecated.');
+        }
+
+        $this->templateClassFormatter = $templateClassFormatter;
     }
 
     /**
@@ -239,4 +250,9 @@ public function generateTemplate(string $targetPath, string $templateName, array
             $variables
         );
     }
+
+    public function getTemplateClassDetails(string $fullClassName): TemplateClassDetails
+    {
+        return $this->templateClassFormatter->generateClassDetailsForTemplate($fullClassName);
+    }
 }

src/Maker/MakeAuthenticator.php

@@ -19,6 +19,7 @@
 use Symfony\Bundle\MakerBundle\Generator;
 use Symfony\Bundle\MakerBundle\InputConfiguration;
 use Symfony\Bundle\MakerBundle\Security\InteractiveSecurityHelper;
+use Symfony\Bundle\MakerBundle\Security\SecurityCompatUtil;
 use Symfony\Bundle\MakerBundle\Security\SecurityConfigUpdater;
 use Symfony\Bundle\MakerBundle\Security\SecurityControllerBuilder;
 use Symfony\Bundle\MakerBundle\Str;
@@ -60,12 +61,15 @@ final class MakeAuthenticator extends AbstractMaker
 
     private $useSecurity52 = false;
 
-    public function __construct(FileManager $fileManager, SecurityConfigUpdater $configUpdater, Generator $generator, DoctrineHelper $doctrineHelper)
+    private $securityCompatUtil;
+
+    public function __construct(FileManager $fileManager, SecurityConfigUpdater $configUpdater, Generator $generator, DoctrineHelper $doctrineHelper, SecurityCompatUtil $securityCompatUtil)
     {
         $this->fileManager = $fileManager;
         $this->configUpdater = $configUpdater;
         $this->generator = $generator;
         $this->doctrineHelper = $doctrineHelper;
+        $this->securityCompatUtil = $securityCompatUtil;
     }
 
     public static function getCommandName(): string
@@ -275,6 +279,14 @@ private function generateAuthenticatorClass(array $securityData, string $authent
             'Entity\\'
         );
 
+        $hasEncoder = $this->userClassHasEncoder($securityData, $userClass);
+        $userPasswordEncoder = null;
+
+        if ($hasEncoder) {
+            $encoderDetails = $this->securityCompatUtil->getPasswordEncoderClassNameDetails();
+            $userPasswordEncoder = $this->generator->getTemplateClassDetails($encoderDetails->getFullName());
+        }
+
         $this->generator->generateClass(
             $authenticatorClass,
             sprintf('authenticator/%sLoginFormAuthenticator.tpl.php', $this->useSecurity52 ? 'Security52' : ''),
@@ -285,6 +297,7 @@ private function generateAuthenticatorClass(array $securityData, string $authent
                 'username_field_label' => Str::asHumanWords($userNameField),
                 'username_field_var' => Str::asLowerCamelCase($userNameField),
                 'user_needs_encoder' => $this->userClassHasEncoder($securityData, $userClass),
+                'password_encoder_details' => $userPasswordEncoder,
                 'user_is_entity' => $this->doctrineHelper->isClassAMappedEntity($userClass),
                 'provider_key_type_hint' => $this->providerKeyTypeHint(),
             ]

src/Resources/config/makers.xml

@@ -12,6 +12,7 @@
                 <argument type="service" id="maker.security_config_updater" />
                 <argument type="service" id="maker.generator" />
                 <argument type="service" id="maker.doctrine_helper" />
+                <argument type="service" id="maker.security_compat_util" />
                 <tag name="maker.command" />
             </service>
 

src/Resources/config/services.xml

@@ -50,6 +50,7 @@
                 <argument type="service" id="maker.file_manager" />
                 <argument /> <!-- root namespace -->
                 <argument type="service" id="maker.php_compat_util" />
+                <argument type="service" id="maker.template_class_formatter" />
             </service>
 
             <service id="maker.entity_class_generator" class="Symfony\Bundle\MakerBundle\Doctrine\EntityClassGenerator">
@@ -68,5 +69,11 @@
             <service id="maker.php_compat_util" class="Symfony\Bundle\MakerBundle\Util\PhpCompatUtil">
                 <argument type="service" id="maker.file_manager" />
             </service>
+
+            <service id="maker.template_class_formatter" class="Symfony\Bundle\MakerBundle\Util\TemplateClassFormatter">
+                <argument type="service" id="maker.php_compat_util" />
+            </service>
+
+            <service id="maker.security_compat_util" class="Symfony\Bundle\MakerBundle\Security\SecurityCompatUtil" />
         </services>
 </container>

src/Resources/skeleton/authenticator/LoginFormAuthenticator.tpl.php

@@ -8,7 +8,7 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
-<?= $user_needs_encoder ? "use Symfony\\Component\\Security\\Core\\Encoder\\UserPasswordEncoderInterface;\n" : null ?>
+<?= $user_needs_encoder ? $password_encoder_details->getUseStatement() : null ?>
 use Symfony\Component\Security\Core\Exception\CustomUserMessageAuthenticationException;
 use Symfony\Component\Security\Core\Exception\InvalidCsrfTokenException;
 use Symfony\Component\Security\Core\Security;
@@ -29,14 +29,14 @@ class <?= $class_name; ?> extends AbstractFormLoginAuthenticator<?= $password_au
 <?= $user_is_entity ? "    private \$entityManager;\n" : null ?>
     private $urlGenerator;
     private $csrfTokenManager;
-<?= $user_needs_encoder ? "    private \$passwordEncoder;\n" : null ?>
+<?= $user_needs_encoder ? $password_encoder_details->getPropertyStatement() : null ?>
 
-    public function __construct(<?= $user_is_entity ? 'EntityManagerInterface $entityManager, ' : null ?>UrlGeneratorInterface $urlGenerator, CsrfTokenManagerInterface $csrfTokenManager<?= $user_needs_encoder ? ', UserPasswordEncoderInterface $passwordEncoder' : null ?>)
+    public function __construct(<?= $user_is_entity ? 'EntityManagerInterface $entityManager, ' : null ?>UrlGeneratorInterface $urlGenerator, CsrfTokenManagerInterface $csrfTokenManager<?= $user_needs_encoder ? sprintf(', %s', $password_encoder_details->getMethodArgument()) : null ?>)
     {
 <?= $user_is_entity ? "        \$this->entityManager = \$entityManager;\n" : null ?>
         $this->urlGenerator = $urlGenerator;
         $this->csrfTokenManager = $csrfTokenManager;
-<?= $user_needs_encoder ? "        \$this->passwordEncoder = \$passwordEncoder;\n" : null ?>
+<?= $user_needs_encoder ? $password_encoder_details->getConstructorArgument() : null ?>
     }
 
     public function supports(Request $request)
@@ -82,10 +82,13 @@ public function getUser($credentials, UserProviderInterface $userProvider)
 
     public function checkCredentials($credentials, UserInterface $user)
     {
-        <?= $user_needs_encoder ? "return \$this->passwordEncoder->isPasswordValid(\$user, \$credentials['password']);\n"
-        : "// Check the user's password or other credentials and return true or false
+<?php if ($user_needs_encoder): ?>
+        return <?= $password_encoder_details->getProperty() ?>->isPasswordValid($user, $credentials['password']);
+<?php else: ?>
+        // Check the user's password or other credentials and return true or false
         // If there are no credentials to check, you can just return true
-        throw new \Exception('TODO: check the credentials inside '.__FILE__);\n" ?>
+        throw new \Exception('TODO: check the credentials inside '.__FILE__);
+<?php endif; ?>
     }
 
 <?php if ($password_authenticated): ?>

src/Security/SecurityCompatUtil.php

@@ -0,0 +1,34 @@
+<?php
+
+/*
+ * This file is part of the Symfony MakerBundle package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\MakerBundle\Security;
+
+use Symfony\Bundle\MakerBundle\Str;
+use Symfony\Bundle\MakerBundle\Util\ClassNameDetails;
+use Symfony\Component\PasswordHasher\Hasher\UserPasswordHasherInterface;
+use Symfony\Component\Security\Core\Encoder\UserPasswordEncoderInterface;
+
+/**
+ * @author Jesse Rushlow <[email protected]>
+ *
+ * @internal
+ */
+final class SecurityCompatUtil
+{
+    public function getPasswordEncoderClassNameDetails(): ClassNameDetails
+    {
+        if (interface_exists(UserPasswordHasherInterface::class)) {
+            return new ClassNameDetails(UserPasswordHasherInterface::class, Str::getNamespace(UserPasswordHasherInterface::class));
+        }
+
+        return new ClassNameDetails(UserPasswordEncoderInterface::class, Str::getNamespace(UserPasswordEncoderInterface::class));
+    }
+}

src/Util/TemplateClassDetails.php

@@ -0,0 +1,93 @@
+<?php
+
+/*
+ * This file is part of the Symfony MakerBundle package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\MakerBundle\Util;
+
+use Symfony\Bundle\MakerBundle\Str;
+
+/**
+ * @author Jesse Rushlow <[email protected]>
+ *
+ * @internal
+ */
+final class TemplateClassDetails
+{
+    private $fullClassName;
+    private $shortClassName;
+    private $isTyped;
+
+    public function __construct(string $fullClassName, bool $isTyped)
+    {
+        $this->fullClassName = $fullClassName;
+        $this->shortClassName = Str::getShortClassName($fullClassName);
+        $this->isTyped = $isTyped;
+    }
+
+    public function getUseStatement(bool $trailingNewLine = true): string
+    {
+        $stmt = sprintf('use %s;', $this->fullClassName);
+
+        if ($trailingNewLine) {
+            $stmt = sprintf("%s\n", $stmt);
+        }
+
+        return $stmt;
+    }
+
+    public function getPropertyStatement(bool $trailingNewLine = true, bool $indent = true): string
+    {
+        if ($this->isTyped) {
+            $stmt = sprintf('private %s %s;', $this->shortClassName, $this->getVariable());
+        } else {
+            $stmt = sprintf('private %s;', $this->getVariable());
+        }
+
+        if ($trailingNewLine) {
+            $stmt = sprintf("%s\n", $stmt);
+        }
+
+        if ($indent) {
+            $stmt = sprintf('    %s', $stmt);
+        }
+
+        return $stmt;
+    }
+
+    public function getConstructorArgument(bool $trailingNewLine = true, bool $indent = true): string
+    {
+        $stmt = sprintf('$this->%s = %s;', Str::asLowerCamelCase($this->shortClassName), $this->getVariable());
+
+        if ($trailingNewLine) {
+            $stmt = sprintf("%s\n", $stmt);
+        }
+
+        if ($indent) {
+            $stmt = sprintf('        %s', $stmt);
+        }
+
+        return $stmt;
+    }
+
+    public function getMethodArgument(): string
+    {
+        return sprintf('%s %s', $this->shortClassName, $this->getVariable());
+    }
+
+    public function getProperty(): string
+    {
+        return sprintf('$this->%s', Str::asLowerCamelCase($this->shortClassName));
+    }
+
+    public function getVariable(): string
+    {
+        return sprintf('$%s', Str::asLowerCamelCase($this->shortClassName));
+    }
+}

src/Util/TemplateClassFormatter.php

@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * This file is part of the Symfony MakerBundle package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\MakerBundle\Util;
+
+/**
+ * @author Jesse Rushlow <[email protected]>
+ *
+ * @internal
+ */
+class TemplateClassFormatter
+{
+    private $phpCompatUtil;
+
+    public function __construct(PhpCompatUtil $phpCompatUtil)
+    {
+        $this->phpCompatUtil = $phpCompatUtil;
+    }
+
+    public function generateClassDetailsForTemplate(string $className): TemplateClassDetails
+    {
+        return new TemplateClassDetails($className, $this->phpCompatUtil->canUseTypedProperties());
+    }
+}

tests/Util/TemplateClassDetailsTest.php

@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * This file is part of the Symfony MakerBundle package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\MakerBundle\Tests\Util;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Bundle\MakerBundle\MakerBundle;
+use Symfony\Bundle\MakerBundle\Util\TemplateClassDetails;
+
+/**
+ * @author Jesse Rushlow <[email protected]>
+ */
+class TemplateClassDetailsTest extends TestCase
+{
+    public function testDetails(): void
+    {
+        $details = new TemplateClassDetails(MakerBundle::class, false);
+
+        self::assertSame('use Symfony\Bundle\MakerBundle\MakerBundle;', $details->getUseStatement());
+        self::assertSame('    private $makerBundle;', $details->getPropertyStatement());
+        self::assertSame('MakerBundle $makerBundle', $details->getMethodArgument());
+        self::assertSame('$makerBundle', $details->getVariable());
+    }
+
+    public function testDetailsTypedProperties(): void
+    {
+        $details = new TemplateClassDetails(MakerBundle::class, true);
+
+        self::assertSame('private MakerBundle $makerBundle;', $details->getPropertyStatement());
+    }
+}