Symfony validation added and custom validations removed from UserController.php. Language files added for validation error messages.

Author: aksinha-nerdapplabs

src/ApiBundle/Controller/Admin/UserController.php

@@ -57,14 +57,6 @@ public function newAction(Request $request)
 
         if ($form->isSubmitted() && $form->isValid()) {
           try {
-              $this->validateUsername($form, $locale, new User());
-              $this->validatePassword($form, $locale);
-              $this->validateEmail($form, $locale, new User());
-              $this->validateFirstname($form, $locale);
-              $this->validateDob($form, $locale);
-              $this->validateRoles($form, $locale);
-
-              // Everything ok, now proceed to create the user
               $userManager = $this->container->get('fos_user.user_manager');
               $user = $userManager->createUser();
 
@@ -84,7 +76,6 @@ public function newAction(Request $request)
               $this->addFlash('success', $flashMsg);
 
             } catch(HttpException $e) {
-              // Error messages for this section will come from above validate methods
               return $this->redirectToRoute('admin_user_new');
 
             // Always catch exact exception for which flash message or logger is needed,
@@ -138,13 +129,6 @@ public function editAction(User $user, Request $request)
 
         if ($editForm->isSubmitted() && $editForm->isValid()) {
           try {
-                $this->validateUsername($editForm, $locale, $user);
-                $this->validatePassword($editForm, $locale);
-                $this->validateEmail($editForm, $locale, $user);
-                $this->validateFirstname($editForm, $locale);
-                $this->validateDob($editForm, $locale);
-                $this->validateRoles($editForm, $locale);
-
                 $user->setFirstname($editForm['firstname']->getData());
                 $user->setLastname($editForm['lastname']->getData());
                 $user->setDob($editForm['dob']->getData());
@@ -163,7 +147,6 @@ public function editAction(User $user, Request $request)
             // Always catch exact exception for which flash message or logger is needed,
             // otherwise catch block will not get executed on higher or lower ranked exceptions.
             } catch(HttpException $e) {
-                // Error messages for this section will come from above validate methods
                 return $this->redirectToRoute('admin_user_edit', ['id' => $user->getId()]);
             } catch(\Doctrine\DBAL\Exception\UniqueConstraintViolationException $e) {
                 $flashMsg = $this->get('translator')->trans('flash.user_already_exists');
@@ -182,100 +165,6 @@ public function editAction(User $user, Request $request)
         ]);
     }
 
-    /**
-      * Validate username
-      */
-    private function validateUsername(\Symfony\Component\Form\Form $form, $locale, User $user) {
-      $username = $form['username']->getData();
-
-      // Check if username is empty
-      if (null == $username) {
-          $this->logMessageAndFlash(400, 'danger', 'Empty username', $this->get('translator')->trans('api.show_error_username_missing', array(), 'messages', $locale), $locale);
-      }
-
-      // If the username belongs to same user, no need to further check
-      if (!($user->getUsername() == $username)) {
-        // Do a check for existing user with userManager->findByUsername
-        /** @var $user UserInterface */
-        $user = $this->container->get('fos_user.user_manager')->findUserByUsernameOrEmail($username);
-        if (null != $user) {
-          $this->logMessageAndFlash(400, 'danger', 'User already exists. Username: '.$user->getUsername(), $this->get('translator')->trans('api.show_error_username_taken', array(), 'messages', $locale), $locale);
-        }
-      }
-    }
-
-    /**
-      * Validate password
-      */
-    private function validatePassword(\Symfony\Component\Form\Form $form, $locale) {
-      $password = $form['password']->getData();
-
-      // Check if password is empty
-      if (null == $password) {
-          $this->logMessageAndFlash(400, 'danger', 'Invalid empty password', $this->get('translator')->trans('api.show_error_password', array(), 'messages', $locale), $locale);
-      }
-    }
-
-    /**
-      * Validate email
-      */
-    private function validateEmail(\Symfony\Component\Form\Form $form, $locale, User $user) {
-      $email = $form['email']->getData();
-
-      // Check if email is valid
-      if (!filter_var($email, FILTER_VALIDATE_EMAIL)) {
-        $this->logMessageAndFlash(400, 'danger', 'Invalid email: '.$email, $this->get('translator')->trans('api.show_error_email', array(), 'messages', $locale), $locale);
-      }
-
-      // If the email belongs to same user, no need to further check
-      if (!($user->getEmail() == $email )) {
-        $user = $this->container->get('fos_user.user_manager')->findUserByUsernameOrEmail($email);
-        if (null != $user) {
-          $this->logMessageAndFlash(400, 'danger', 'Email '.$user->getEmail().' already taken by Username: '.$user->getUsername(), $this->get('translator')->trans('api.show_error_email_taken', array(), 'messages', $locale), $locale);
-        }
-      }
-    }
-
-    /**
-      * Validate firstname
-      */
-    private function validateFirstname(\Symfony\Component\Form\Form $form, $locale) {
-      $firstname = $form['firstname']->getData();
-
-      // Check if firstname is empty. At least firstname is required.
-      if (null == $firstname) {
-          $this->logMessageAndFlash(400, 'danger', 'Invalid empty firstname', $this->get('translator')->trans('api.show_error_firstname', array(), 'messages', $locale), $locale);
-      }
-
-    }
-
-    /**
-      * Validate dob
-      */
-    private function validateDob(\Symfony\Component\Form\Form $form, $locale) {
-      $dob = $form['dob']->getData();
-
-      // Check if dob is valid
-      list($mm,$dd,$yyyy) = explode('/', $dob->format('m/d/Y') );
-      if (!checkdate($mm,$dd,$yyyy)) {
-          $this->logMessageAndFlash(400, 'danger', 'Invalid mm/dd/yyyy DOB: '.$dob, $this->get('translator')->trans('api.show_error_dob', array(), 'messages', $locale), $locale);
-      }
-    }
-
-    /**
-      * Validate roles
-      */
-    private function validateRoles(\Symfony\Component\Form\Form $form, $locale) {
-      $roles = $form['roles']->getData();
-      $permittedRoles = ['ROLE_API', "ROLE_USER"];
-
-      foreach ($roles as $role) {
-        // Check if role is valid
-        if (!in_array($role, $permittedRoles) )
-        $this->logMessageAndFlash(400, 'warning', 'Invalid role: '.$role, $this->get('translator')->trans('api.show_error_role'.' '.$role, array(), 'messages', $locale), $locale);
-      }
-    }
-
     /**
      * Deletes a User entity.
      *

src/ApiBundle/Entity/User.php

@@ -5,15 +5,12 @@
 
 use FOS\UserBundle\Entity\User as BaseUser;
 use Doctrine\ORM\Mapping as ORM;
-use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
 
 /**
  * User
  *
  * @ORM\Table("users")
  * @ORM\Entity
- * @UniqueEntity("username")
- * @UniqueEntity("email")
  */
 class User extends BaseUser
 {

src/ApiBundle/Resources/config/validation.yml

@@ -0,0 +1,37 @@
+# src/ApiBundle/Resources/config/validation.yml
+ApiBundle\Entity\User:
+    constraints:
+        - Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity:
+              fields: username
+              message: "user.show_error_username_taken"
+        - Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity:
+              fields: email
+              message: "user.show_error_email_taken"
+    properties:
+        firstname:
+            - NotBlank:
+                  message: "user.show_error_firstname"
+        username:
+            - Regex:
+                  pattern: '/^[a-z0-9_-]{3,16}$/'
+                  match:   true
+                  message: "user.show_error_username_policy"
+        password:
+            - Regex:
+                  pattern: '/^([a-zA-Z0-9@*#]{8,15})$/'
+                  match:   true
+                  message: "user.show_error_password_policy"
+        email:
+            - Email:
+                  message: "user.show_error_email"
+                  checkMX: false
+        dob:
+            - Date:
+                  message: "user.show_error_dob"
+        roles:
+            - Type:
+                  type: array
+                  message: The value {{ value }} is not a valid {{ type }}.
+            - Choice:
+                  choices:  ['ROLE_USER', 'ROLE_API']
+                  message:  "user.show_error_role"

src/ApiBundle/Resources/translations/validators.en.yml

@@ -0,0 +1,24 @@
+client:
+  show_error_client_name:  Sorry, Client Name cannot be empty!
+  show_error_url:  Sorry, Redirect URL cannot be empty!
+  show_error_non_admin:  Sorry, you are not an Admin!
+user:
+  show_error_password:  Sorry, Wrong/Missing Password!
+  show_error_username_missing:  Sorry, Wrong/Missing Username!
+  show_error_credentials:  Sorry, Invalid Client Credentials!
+  show_error_username_empty:  Sorry, Empty Username!
+  show_error_username_taken:  Sorry, Username already taken!
+  show_error_email:  Sorry, Wrong/Missing Email!
+  show_error_email_taken:  Sorry, Email already taken!
+  show_error_dob:  Sorry, Invalid date of birth!
+  show_error_scope:  Sorry, Invalid scope!
+  show_error_firstname:  Sorry, Firstname cannot be empty!
+  show_error_password_change:  Sorry, You are not allowed to change password!
+  show_error_password_old:  Sorry, Invalid old password!
+  show_error_perm_show:  Sorry, You are not permitted to view user profile!
+  show_error_perm_edit:  Sorry, You are not permitted to edit user profile!
+  show_error_password_reset:  Sorry, You are not permitted to request for password reset!
+  show_error_reset_req:  Password reset request already received
+  show_error_username_policy:  Username should be 3-16 characters long with any lowercase letter (a-z), number (0-9), an underscore, or a hyphen
+  show_error_password_policy:  Password should be 8-15 characters long and must contain alphanumeric and @*# characters
+  show_error_role: Sorry! Not a valid Role!

src/ApiBundle/Resources/translations/validators.fr.yml

@@ -0,0 +1,24 @@
+client:
+  show_error_client_name:  Désolé, le nom du client ne peut pas être vide!
+  show_error_url:  Désolé, l'URL de redirection ne peut pas être vide!
+  show_error_non_admin:  Désolé, vous n'êtes pas Admin!
+user:
+  show_error_password:  Désolé, mot de passe erroné / manquant!
+  show_error_username_missing:  Désolé, Nom d'utilisateur erroné / manquant!
+  show_error_credentials:  Désolé, Invalid Client Credentials!
+  show_error_username_empty:  Désolé, Nom d'utilisateur vide!
+  show_error_username_taken:  Désolé, Nom d'utilisateur déjà pris!
+  show_error_email:  Désolé, E-mail erroné / manquant!
+  show_error_email_taken:  Désolé, Courriel déjà pris!
+  show_error_dob:  Désolé, date de naissance non valide!
+  show_error_scope:  Désolé, champ non valide!
+  show_error_firstname:  Désolé, le prénom ne peut pas être vide!
+  show_error_password_change:  Désolé, Vous n'êtes pas autorisé à changer de mot de passe!
+  show_error_password_old:  Désolé, ancien mot de passe invalide!
+  show_error_perm_show:  Désolé, Vous n'êtes pas autorisé à voir le profil!
+  show_error_perm_edit:  Désolé, Vous n'êtes pas autorisé à modifier le profil de l'utilisateur!
+  show_error_password_reset:  Désolé, vous n'êtes pas autorisé à demander une réinitialisation du mot de passe!
+  show_error_reset_req:  Réinitialisation du mot de passe déjà reçue
+  show_error_server_fault:  Erreur du serveur! Veuillez réessayer après un certain temps !!
+  show_error_username_policy:  Le nom d'utilisateur doit comporter entre 3 et 16 caractères avec une lettre minuscule (a-z), un chiffre (0-9), un trait de soulignement ou un tiret
+  show_error_password_policy:  Le mot de passe doit comporter entre 8 et 15 caractères et contenir des caractères alphanumériques et @*#

src/ApiBundle/Resources/translations/validators.hi.yml

@@ -0,0 +1,24 @@
+client:
+  show_error_client_name:  क्षमा करें, क्लाइंट का नाम रिक्त नहीं हो सकता!
+  show_error_url:  क्षमा करें, पुनर्निर्देशन यूआरएल खाली नहीं हो सकता!
+  show_error_non_admin:  क्षमा करें, आप एक व्यवस्थापक नहीं हैं!
+user:
+  show_error_password:  माफ करना, गलत / लापता पासवर्ड!
+  show_error_username_missing:  माफ करना, गलत / लापता यूजर का नाम!
+  show_error_credentials:  क्षमा करें, हमारे ग्राहकों का अवैध साख!
+  show_error_username_empty:  क्षमा करें, खाली यूजर का नाम!
+  show_error_username_taken:  क्षमा करें, प्रयोक्ता नाम पहले ही ले लिया!
+  show_error_email:  माफ करना, गलत / लापता ईमेल
+  show_error_email_taken:  क्षमा करें, ईमेल पहले ही ले लिया!
+  show_error_dob:  क्षमा करें, जन्म की तारीख गलत!
+  show_error_scope:  क्षमा करें, अमान्य दायरा!
+  show_error_firstname:  क्षमा करें, प्रथम खाली नहीं हो सकता!
+  show_error_password_change:  क्षमा करें, आप पासवर्ड बदलने की अनुमति नहीं कर रहे हैं!
+  show_error_password_old:  क्षमा करें, अमान्य पुराने पासवर्ड के लिए!
+  show_error_perm_show:  क्षमा करें, आप उपयोगकर्ता प्रोफ़ाइल देखने के लिए अनुमति नहीं है!
+  show_error_perm_edit:  क्षमा करें, आप उपयोगकर्ता के प्रोफ़ाइल को संपादित करने की अनुमति नहीं है!
+  show_error_password_reset:  क्षमा करें, आप पासवर्ड रीसेट के लिए अनुरोध करने के लिए अनुमति नहीं है!
+  show_error_reset_req:  पासवर्ड रीसेट अनुरोध पहले से ही प्राप्त
+  show_error_server_fault:  सर्वर त्रुटि! कुछ समय के बाद फिर से कोशिश करें !!
+  show_error_username_policy:  यूजर का नाम किसी भी छोटा अक्षर (a-z), संख्या (0-9), एक अंडरस्कोर, या एक हाइफन के साथ 3-16 अक्षर का होना चाहिए
+  show_error_password_policy:  पासवर्ड 8-15 अक्षर का होना चाहिए और अल्फान्यूमेरिक और शामिल होना चाहिए @#* अक्षर