feat(Registration): Email verification

src/main/java/org/wise/portal/dao/user/UserDao.java

@@ -46,6 +46,7 @@ List<User> retrieveStudentsByNameAndBirthday(String firstName, String lastName,
   List<User> retrieveTeachersByFirstName(String firstName);
   List<User> retrieveTeachersByLastName(String lastName);
   User retrieveTeacherByUsername(String username);
+  User retrieveTeacherByVerificationCode(String verificationCode);
   List<User> retrieveTeachersByDisplayName(String displayName);
   List<User> retrieveTeachersByCity(String city);
   List<User> retrieveTeachersByState(String state);

src/main/java/org/wise/portal/dao/user/impl/HibernateUserDao.java

@@ -148,8 +148,7 @@ public List<User> retrieveTeachersByLastName(String lastName) {
   }
 
   public User retrieveTeacherByUsername(String username) {
-    List<User> resultList = retrieveTeachersByFieldValue("username", username);
-    return resultList.isEmpty() ? null : resultList.get(0);
+    return retrieveTeacherByFieldValue("username", username);
   }
 
   public List<User> retrieveTeachersByDisplayName(String displayName) {
@@ -176,6 +175,15 @@ public List<User> retrieveTeachersByEmail(String emailAddress) {
     return retrieveTeachersByFieldValue("emailAddress", emailAddress);
   }
 
+  public User retrieveTeacherByVerificationCode(String verificationCode) {
+    return retrieveTeacherByFieldValue("verificationCode", verificationCode);
+  }
+
+  private User retrieveTeacherByFieldValue(String field, String value) {
+    List<User> resultList = retrieveTeachersByFieldValue(field, value);
+    return resultList.isEmpty() ? null : resultList.get(0);
+  }
+
   @SuppressWarnings("unchecked")
   private List<User> retrieveTeachersByFieldValue(String field, String value) {
     CriteriaBuilder cb = getCriteriaBuilder();

src/main/java/org/wise/portal/domain/authentication/impl/TeacherUserDetails.java

@@ -93,6 +93,12 @@ public class TeacherUserDetails extends PersistentUserDetails implements Mutable
   @Transient
   private static final String COLUMN_NAME_HOW_HEAR = "howDidYouHearAboutUs";
 
+  @Transient
+  private static final String COLUMN_NAME_VERIFIED = "isVerified";
+
+  @Transient
+  private static final String COLUMN_NAME_VERIFICATION_CODE = "verificationCode";
+
   @Transient
   private static final long serialVersionUID = 1L;
 
@@ -164,6 +170,16 @@ public class TeacherUserDetails extends PersistentUserDetails implements Mutable
   @Setter
   private String howDidYouHearAboutUs;
 
+  @Column(name = TeacherUserDetails.COLUMN_NAME_VERIFIED, nullable = false)
+  @Getter
+  @Setter
+  private boolean verified = false;
+
+  @Column(name = TeacherUserDetails.COLUMN_NAME_VERIFICATION_CODE, unique = true)
+  @Getter
+  @Setter
+  private String verificationCode;
+
   public String getCoreUsername() {
     return (firstname + lastname).replaceAll("[\\s-]+", "");
   }

src/main/java/org/wise/portal/presentation/web/controllers/teacher/TeacherAPIController.java

@@ -6,6 +6,7 @@
 import java.util.Locale;
 import java.util.Set;
 import java.util.TreeSet;
+import java.util.UUID;
 
 import javax.servlet.http.HttpServletRequest;
 
@@ -326,4 +327,20 @@ HashMap<String, Object> editRunIsLockedAfterEndDate(Authentication authenticatio
     }
     return response;
   }
+
+  @GetMapping("/is-verified")
+  @Secured({ "ROLE_ANONYMOUS" })
+  public boolean isVerifiedTeacherOrNonTeacher(@RequestParam String username) {
+    User user = userService.retrieveTeacherByUsername(username);
+    return !this.isTeacher(user) || this.isTeacherVerified(user); // Only teachers need to verify their accounts
+  }
+
+  protected boolean isTeacher(User user) {
+    return user != null && !user.getRoles().contains("ROLE_STUDENT");
+  }
+
+  private boolean isTeacherVerified(User user) {
+    TeacherUserDetails tud = (TeacherUserDetails) user.getUserDetails();
+    return tud.isVerified();
+  }
 }

src/main/java/org/wise/portal/presentation/web/controllers/teacher/TeacherRegistrationAPIController.java

@@ -1,17 +1,22 @@
 package org.wise.portal.presentation.web.controllers.teacher;
 
+import java.io.IOException;
 import java.util.Locale;
 import java.util.Map;
+import java.util.UUID;
 
-import javax.mail.MessagingException;
 import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
 
 import org.apache.commons.lang3.RandomStringUtils;
+import org.springframework.dao.DataIntegrityViolationException;
 import org.springframework.http.ResponseEntity;
 import org.springframework.security.access.annotation.Secured;
+import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 import org.wise.portal.domain.authentication.Schoollevel;
 import org.wise.portal.domain.authentication.impl.TeacherUserDetails;
@@ -26,12 +31,6 @@
 @RestController
 @RequestMapping("/api/teacher/register")
 public class TeacherRegistrationAPIController extends TeacherAPIController {
-
-  private final String emailCodePrefix = 
-    "presentation.web.controllers.teacher.registerTeacherController.welcomeTeacherEmail";
-  private final String welcomeBodyCode = this.emailCodePrefix + "Body";
-  private final String welcomeSocialAccountBodyCode = this.emailCodePrefix + "BodyNoUsername";
-  private final String welcomeSubjectCode = this.emailCodePrefix + "Subject";
 
   @PostMapping()
   @Secured({ "ROLE_ANONYMOUS" })
@@ -47,60 +46,26 @@ ResponseEntity<Map<String, Object>> createTeacherAccount(
         passwordService.getErrors(teacherFields.get("password")));
     }
     Locale locale = request.getLocale();
-    TeacherUserDetails tud = createTeacherUserDetails(teacherFields, locale);
+    boolean isSocialAccount = isSocialAccount(teacherFields);
+    TeacherUserDetails tud = createTeacherUserDetails(teacherFields, isSocialAccount, locale);
     User createdUser = this.userService.createUser(tud);
     String username = createdUser.getUserDetails().getUsername();
-    if (isSendEmailEnabled()) {
-      sendWelcomeTeacherEmail(tud.getEmailAddress(), tud.getDisplayname(), username, 
-                              isSocialAccount(tud), locale, request);
-    }
+    sendNewTeacherEmail(request, locale, isSocialAccount, tud, username);
     return createRegisterSuccessResponse(username);
   }
 
-  private boolean isSendEmailEnabled() {
-    String sendEmailEnabledStr = appProperties.getProperty("send_email_enabled", "false");
-    return Boolean.valueOf(sendEmailEnabledStr);
-  }
-
-  private boolean isSocialAccount(TeacherUserDetails tud) {
-      return isSet(tud.getGoogleUserId()) || isSet(tud.getMicrosoftUserId());
-  }
-
-  private void sendWelcomeTeacherEmail(String email, String displayName, String username,
-                                       boolean socialAccount, Locale locale, 
-                                       HttpServletRequest request) {
-    String subject = getEmailMessage(this.welcomeSubjectCode, this.welcomeSubjectCode, null, locale);
-    String body = getWelcomeTeacherBody(displayName, username, socialAccount, locale, request);
-    this.sendEmail(email, subject, body);
-  }
-
-  private String getEmailMessage(String defaultCode, String code, Object[] args, Locale locale) {
-    String defaultMessage = messageSource.getMessage(defaultCode, args, Locale.US);
-    return messageSource.getMessage(code, args, defaultMessage, locale);
-  }
-
-  private String getWelcomeTeacherBody(String displayName, String username, boolean socialAccount,
-                                       Locale locale, HttpServletRequest request) {
-    String gettingStartedUrl = getGettingStartedUrl(request);
-    String code = socialAccount ? this.welcomeSocialAccountBodyCode : this.welcomeBodyCode;
-    Object[] args = socialAccount 
-      ? new Object[] { displayName, gettingStartedUrl } 
-      : new Object[] { displayName, username, gettingStartedUrl };
-    return getEmailMessage(this.welcomeBodyCode, code, args, locale);
-  }
-
-  private String getGettingStartedUrl(HttpServletRequest request) {
-    return ControllerUtil.getPortalUrlString(request) + "/help/getting-started";
+  private void sendNewTeacherEmail(HttpServletRequest request, Locale locale, boolean isSocialAccount,
+      TeacherUserDetails tud, String username) {
+    if (isSocialAccount) {
+      this.mailService.sendWelcomeTeacherEmail(tud.getEmailAddress(), tud.getDisplayname(), username, 
+                                true, locale, request);
+    } else {
+      this.mailService.sendVerifyTeacherEmail(tud.getEmailAddress(), tud.getVerificationCode(), locale, request);
+    }
   }
 
-  private void sendEmail(String email, String subject, String body) {
-    String fromEmail = appProperties.getProperty("portalemailaddress");
-    String[] recipients = { email };
-    try {
-      mailService.postMail(recipients, subject, body, fromEmail);
-    } catch (MessagingException e) {
-      e.printStackTrace();
-    }
+  private boolean isSocialAccount(Map<String, String> teacherFields) {
+      return isSet(teacherFields.get("googleUserId")) || isSet(teacherFields.get("microsoftUserId"));
   }
 
   private void validateTeacherFields(Map<String, String> teacherFields) 
@@ -133,7 +98,7 @@ private void validatePassword(String password) throws InvalidPasswordException {
   }
 
   private TeacherUserDetails createTeacherUserDetails(Map<String, String> teacherFields, 
-                                                      Locale locale) {
+                                                      boolean isSocialAccount, Locale locale) {
     TeacherUserDetails tud = new TeacherUserDetails();
     tud.setFirstname(teacherFields.get("firstName"));
     tud.setLastname(teacherFields.get("lastName"));
@@ -148,6 +113,8 @@ private TeacherUserDetails createTeacherUserDetails(Map<String, String> teacherF
     tud.setLanguage(locale.getLanguage());
     setPassword(teacherFields, tud);
     tud.setEmailValid(true);
+    tud.setVerified(isSocialAccount || !mailService.isSendEmailEnabled());
+    setVerificationCode(tud);
     return tud;
   }
 
@@ -164,6 +131,18 @@ private void setPassword(Map<String, String> teacherFields, TeacherUserDetails t
       tud.setPassword(teacherFields.get("password"));
     }
   }
+
+  private void setVerificationCode(TeacherUserDetails tud) {
+    boolean isCodeSet = false;
+    while (!isCodeSet) {
+      try {
+        tud.setVerificationCode(UUID.randomUUID().toString());
+        isCodeSet = true;
+      } catch (DataIntegrityViolationException e) {
+        continue;
+      }
+    }
+  }
 
   private boolean isSet(String value) {
     return value != null && !value.isEmpty();
@@ -172,4 +151,70 @@ private boolean isSet(String value) {
   private void setRandomPassword(TeacherUserDetails tud) {
     tud.setPassword(RandomStringUtils.random(10, true, true));
   }
+
+  @GetMapping("/verify")
+  @Secured({ "ROLE_ANONYMOUS" })
+  public void verifyTeacherAndRedirect(@RequestParam String code, HttpServletResponse response,
+                                       HttpServletRequest request) throws IOException {
+    User user = userService.retrieveTeacherByVerificationCode(code);
+    String link = verifyTeacherIfNecessaryAndGetLoginLink(request, user);
+    sendWelcomeEmailIfNecessary(user, link, request);
+    response.sendRedirect(link);
+  }
+
+  private String verifyTeacherIfNecessaryAndGetLoginLink(HttpServletRequest request, User user) {
+    String link;
+    if (user == null) {
+      link = "/login?verified=error";
+    } else if (!isTeacher(user)) {
+      link = getRedirectLink(user, false);
+    } else {
+      TeacherUserDetails tud = (TeacherUserDetails) user.getUserDetails();
+      boolean verified = verifyTeacherAccount(user, tud, request);
+      link = getRedirectLink(user, verified);
+    }
+    return link;
+  }
+
+  private void sendWelcomeEmailIfNecessary(User user, String link, HttpServletRequest request) {
+    if (link.contains("verified=true")) {
+      TeacherUserDetails tud = (TeacherUserDetails) user.getUserDetails();
+      this.mailService.sendWelcomeTeacherEmail(tud.getEmailAddress(), tud.getDisplayname(), tud.getUsername(),
+                                               false, request.getLocale(), request);
+    }
+  }
+
+  private String getRedirectLink(User user, boolean verified) {
+    return String.format("/login?verified=%s&username=%s", 
+                         verified, user.getUserDetails().getUsername());
+  }
+
+  private boolean verifyTeacherAccount(User user, TeacherUserDetails tud, HttpServletRequest request) {
+    if (!tud.isVerified()) {
+      tud.setVerified(true);
+      userService.updateUser(user);
+      return true;
+    } else {
+      return false;
+    }
+  }
+
+  @PostMapping("send-verify-email")
+  @Secured({ "ROLE_ANONYMOUS" })
+  ResponseEntity<Map<String, Object>> sendVerificationEmail(@RequestParam String username, 
+                                                            HttpServletRequest request) {
+    User user = userService.retrieveTeacherByUsername(username);
+    if (isTeacher(user)) {
+      TeacherUserDetails tud = (TeacherUserDetails) user.getUserDetails();
+      if (tud.isVerified()) {
+        return ResponseEntityGenerator.createError("Teacher already verified");
+      } else {
+        this.mailService.sendVerifyTeacherEmail(tud.getEmailAddress(), tud.getVerificationCode(), 
+                                                request.getLocale(), request);
+        return createRegisterSuccessResponse(username);
+      }
+    } else {
+      return ResponseEntityGenerator.createError("Not a teacher"); 
+    }
+  }
 }

src/main/java/org/wise/portal/presentation/web/controllers/user/UserAPIController.java

@@ -118,6 +118,7 @@ HashMap<String, Object> getUserInfo(Authentication auth,
         info.put("country", tud.getCountry());
         info.put("schoolName", tud.getSchoolname());
         info.put("schoolLevel", tud.getSchoollevel());
+        info.put("isVerified", tud.isVerified());
       }
       return info;
     } else {

src/main/java/org/wise/portal/service/mail/IMailFacade.java

@@ -23,7 +23,12 @@
  */
 package org.wise.portal.service.mail;
 
+import java.util.Locale;
+
 import javax.mail.MessagingException;
+import javax.servlet.http.HttpServletRequest;
+
+import org.wise.portal.domain.authentication.impl.TeacherUserDetails;
 
 /**
  * @author Anthony Perritano
@@ -46,4 +51,11 @@ void postMail(String recipients[], String subject, String message , String from)
   void postMail(String recipients[], String subject, String message , String from, String[] cc)
       throws MessagingException;
 
+  void sendWelcomeTeacherEmail(String email, String displayName, String username, 
+      boolean socialAccount, Locale locale, HttpServletRequest request);
+
+  void sendVerifyTeacherEmail(String email, String verificationCode, Locale locale, 
+      HttpServletRequest request);
+
+  boolean isSendEmailEnabled();
 }