form login : use dynamic username field

Author: nikophil

composer.json

@@ -20,10 +20,10 @@
         "symfony/dependency-injection": "^3.4|^4.0",
         "symfony/filesystem": "^3.4|^4.0",
         "symfony/finder": "^3.4|^4.0",
-        "symfony/form": "^4.1",
+        "symfony/form": "^3.4|^4.1",
         "symfony/framework-bundle": "^3.4|^4.0",
         "symfony/http-kernel": "^3.4|^4.0",
-        "symfony/security": "^4.1"
+        "symfony/security": "^3.4|^4.1"
     },
     "require-dev": {
         "allocine/twigcs": "^3.0",

src/Doctrine/DoctrineHelper.php

@@ -184,6 +184,6 @@ public function isClassAMappedEntity(string $className): bool
             return false;
         }
 
-        return (bool) $this->getMetadata(trim($className, '\\'));
+        return (bool) $this->getMetadata($className);
     }
 }

src/Maker/MakeAuthenticator.php

@@ -122,10 +122,7 @@ function ($answer) {
                 Validator::notBlank($answer);
 
                 return Validator::classDoesNotExist(
-                    $this->generator->createClassNameDetails(
-                        $answer,
-                        'Security\\'
-                    )->getFullName()
+                    $this->generator->createClassNameDetails($answer, 'Security\\', 'Authenticator')->getFullName()
                 );
             }
         );
@@ -152,9 +149,17 @@ function ($answer) {
                 )
             );
 
-            $command->addArgument('user-class', InputArgument::OPTIONAL);
-            $userClass = $interactiveSecurityHelper->guessUserClass($io, $securityData['security']['providers']);
-            $input->setArgument('user-class', $userClass);
+            $command->addArgument('user-class', InputArgument::REQUIRED);
+            $input->setArgument(
+                'user-class',
+                $userClass = $interactiveSecurityHelper->guessUserClass($io, $securityData['security']['providers'])
+            );
+
+            $command->addArgument('username-field', InputArgument::REQUIRED);
+            $input->setArgument(
+                'username-field',
+                $interactiveSecurityHelper->guessUserNameField($io, $userClass, $securityData['security']['providers'])
+            );
         }
     }
 
@@ -219,27 +224,22 @@ private function generateAuthenticatorClass(InputInterface $input)
                 }
             }
 
-            if ($this->doctrineHelper->isClassAMappedEntity($input->getArgument('user-class'))) {
-                $userClassNameDetails = $this->generator->createClassNameDetails(
-                    '\\'.$input->getArgument('user-class'),
-                    'Entity\\'
-                );
+            $userClassNameDetails = $this->generator->createClassNameDetails(
+                '\\'.$input->getArgument('user-class'),
+                'Entity\\'
+            );
 
-                $this->generator->generateClass(
-                    $input->getArgument('authenticator-class'),
-                    $userNeedsEncoder ? 'authenticator/LoginFormEntityAuthenticator.tpl.php' : 'authenticator/LoginFormEntityAuthenticatorNoEncoder.tpl.php',
-                    [
-                        'user_fully_qualified_class_name' => trim($userClassNameDetails->getFullName(), '\\'),
-                        'user_class_name' => $userClassNameDetails->getShortName(),
-                    ]
-                );
-            } else {
-                $this->generator->generateClass(
-                    $input->getArgument('authenticator-class'),
-                    $userNeedsEncoder ? 'authenticator/LoginFormNotEntityAuthenticator.tpl.php' : 'authenticator/LoginFormNotEntityAuthenticatorNoEncoder.tpl.php',
-                    []
-                );
-            }
+            $this->generator->generateClass(
+                $input->getArgument('authenticator-class'),
+                'authenticator/LoginFormAuthenticator.tpl.php',
+                [
+                    'user_fully_qualified_class_name' => trim($userClassNameDetails->getFullName(), '\\'),
+                    'user_class_name' => $userClassNameDetails->getShortName(),
+                    'username_field' => $input->getArgument('username-field'),
+                    'user_needs_encoder' => $userNeedsEncoder,
+                    'user_is_entity' => $this->doctrineHelper->isClassAMappedEntity($input->getArgument('user-class'))
+                ]
+            );
         }
     }
 
@@ -282,7 +282,7 @@ private function generateFormLoginFiles(InputInterface $input)
             'templates/security/login.html.twig',
             'authenticator/login_form.tpl.php',
             [
-                'controller_path' => $controllerPath,
+                'username_field' => $input->getArgument('username-field')
             ]
         );
     }

src/Resources/skeleton/authenticator/LoginFormNotEntityAuthenticator.tpl.php renamed to src/Resources/skeleton/authenticator/LoginFormAuthenticator.tpl.php

@@ -2,11 +2,13 @@
 
 namespace <?= $namespace ?>;
 
+<?= $user_is_entity ? "use $user_fully_qualified_class_name;\n" : null ?>
+<?= $user_is_entity ? "use Doctrine\\ORM\\EntityManagerInterface;\n" : null ?>
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\Routing\RouterInterface;
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
-use Symfony\Component\Security\Core\Encoder\UserPasswordEncoderInterface;
+<?= $user_needs_encoder ? "use Symfony\\Component\\Security\\Core\\Encoder\\UserPasswordEncoderInterface;\n" : null ?>
 use Symfony\Component\Security\Core\Exception\InvalidCsrfTokenException;
 use Symfony\Component\Security\Core\Security;
 use Symfony\Component\Security\Core\User\UserInterface;
@@ -20,15 +22,17 @@ class <?= $class_name; ?> extends AbstractFormLoginAuthenticator
 {
     use TargetPathTrait;
 
+<?= $user_is_entity ? "    private \$entityManager;\n" : null ?>
     private $router;
     private $csrfTokenManager;
-    private $passwordEncoder;
+<?= $user_needs_encoder ? "    private \$passwordEncoder;\n" : null ?>
 
-    public function __construct(RouterInterface $router, CsrfTokenManagerInterface $csrfTokenManager, UserPasswordEncoderInterface $passwordEncoder)
+    public function __construct(<?= $user_is_entity ? 'EntityManagerInterface $entityManager, ' : null ?>RouterInterface $router, CsrfTokenManagerInterface $csrfTokenManager<?= $user_needs_encoder ? ', UserPasswordEncoderInterface $passwordEncoder' : null ?>)
     {
+<?= $user_is_entity ? "        \$this->entityManager = \$entityManager;\n" : null ?>
         $this->router = $router;
         $this->csrfTokenManager = $csrfTokenManager;
-        $this->passwordEncoder = $passwordEncoder;
+<?= $user_needs_encoder ? "        \$this->passwordEncoder = \$passwordEncoder;\n" : null ?>
     }
 
     public function supports(Request $request)
@@ -40,13 +44,13 @@ public function supports(Request $request)
     public function getCredentials(Request $request)
     {
         $credentials = [
-            'email' => $request->request->get('email'),
+            '<?= $username_field ?>' => $request->request->get('<?= $username_field ?>'),
             'password' => $request->request->get('password'),
             'csrf_token' => $request->request->get('_csrf_token'),
         ];
         $request->getSession()->set(
             Security::LAST_USERNAME,
-            $credentials['email']
+            $credentials['<?= $username_field ?>']
         );
 
         return $credentials;
@@ -59,14 +63,15 @@ public function getUser($credentials, UserProviderInterface $userProvider)
             throw new InvalidCsrfTokenException();
         }
 
-        // Load / create our user however you need.
+        <?= $user_is_entity ? "return \$this->entityManager->getRepository($user_class_name::class)->findOneBy(['$username_field' => \$credentials['$username_field']]);\n"
+        : "// Load / create our user however you need.
         // You can do this by calling the user provider, or with custom logic here.
-        return $userProvider->loadUserByUsername($credentials['email']);
+        return \$userProvider->loadUserByUsername(\$credentials['$username_field']);\n"; ?>
     }
 
     public function checkCredentials($credentials, UserInterface $user)
     {
-        return $this->passwordEncoder->isPasswordValid($user, $credentials['password']);
+        <?= $user_needs_encoder ? "return \$this->passwordEncoder->isPasswordValid(\$user, \$credentials['password']);\n" : "return true;\n" ?>
     }
 
     public function onAuthenticationSuccess(Request $request, TokenInterface $token, $providerKey)