feat(Registration): Email verification

src/main/java/org/wise/portal/dao/authentication/TeacherUserDetailsDao.java

@@ -0,0 +1,9 @@
+package org.wise.portal.dao.authentication;
+
+import org.wise.portal.dao.SimpleDao;
+import org.wise.portal.domain.authentication.impl.TeacherUserDetails;
+
+public interface TeacherUserDetailsDao extends SimpleDao<TeacherUserDetails> {
+
+  boolean hasVerificationCode(String verificationCode);
+}

src/main/java/org/wise/portal/dao/authentication/impl/HibernateTeacherUserDetailsDao.java

@@ -0,0 +1,33 @@
+package org.wise.portal.dao.authentication.impl;
+
+import javax.persistence.TypedQuery;
+import javax.persistence.criteria.CriteriaBuilder;
+import javax.persistence.criteria.CriteriaQuery;
+import javax.persistence.criteria.Root;
+
+import org.springframework.stereotype.Repository;
+import org.wise.portal.dao.authentication.TeacherUserDetailsDao;
+import org.wise.portal.dao.impl.AbstractHibernateDao;
+import org.wise.portal.domain.authentication.impl.TeacherUserDetails;
+
+@Repository
+public class HibernateTeacherUserDetailsDao extends AbstractHibernateDao<TeacherUserDetails> 
+    implements TeacherUserDetailsDao {
+
+  @Override
+  public boolean hasVerificationCode(String verificationCode) {
+    CriteriaBuilder cb = getCriteriaBuilder();
+    CriteriaQuery<Long> cq = cb.createQuery(Long.class);
+    Root<TeacherUserDetails> teacherUserDetailsRoot = cq.from(TeacherUserDetails.class);
+    cq.select(cb.count(teacherUserDetailsRoot))
+        .where(cb.equal(teacherUserDetailsRoot.get("verificationCode"), verificationCode));
+    TypedQuery<Long> query = entityManager.createQuery(cq);
+    Long count = query.getSingleResult();
+    return count > 0;
+  }
+
+  @Override
+  protected Class<? extends TeacherUserDetails> getDataObjectClass() {
+    return TeacherUserDetails.class;
+  }
+}

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

@@ -25,6 +25,7 @@
 
 import java.util.Date;
 import java.util.HashMap;
+import java.util.UUID;
 
 import javax.persistence.Column;
 import javax.persistence.Entity;
@@ -93,6 +94,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 +171,15 @@ 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
+  private String verificationCode;
+
   public String getCoreUsername() {
     return (firstname + lastname).replaceAll("[\\s-]+", "");
   }
@@ -183,9 +199,7 @@ public String[] getUsernameSuffixes() {
    */
   public String getNextUsernameSuffix(String currentUsernameSuffix) {
     String nextUsernameSuffix = "";
-    if (currentUsernameSuffix == null) {
-      nextUsernameSuffix = "";
-    } else if ("".equals(currentUsernameSuffix)) {
+    if ("".equals(currentUsernameSuffix)) {
       nextUsernameSuffix = "1";
     } else {
       try {
@@ -238,4 +252,8 @@ public boolean isEmailValid() {
   public void setEmailValid(boolean emailValid) {
     this.emailValid = emailValid;
   }
+
+  public void setVerificationCode() {
+    this.verificationCode = UUID.randomUUID().toString();
+  }
 }

src/main/java/org/wise/portal/presentation/web/TeacherVerificationAPIController.java

@@ -0,0 +1,67 @@
+package org.wise.portal.presentation.web;
+
+import java.io.IOException;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+import org.springframework.security.access.annotation.Secured;
+import org.springframework.web.bind.annotation.GetMapping;
+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.impl.TeacherUserDetails;
+import org.wise.portal.domain.user.User;
+import org.wise.portal.presentation.web.controllers.teacher.TeacherAPIController;
+
+@RestController
+@RequestMapping("/api/teacher/verify")
+public class TeacherVerificationAPIController extends TeacherAPIController {
+
+  @GetMapping()
+  @Secured({ "ROLE_ANONYMOUS" })
+  public void verifyTeacherAndRedirect(@RequestParam String code, HttpServletResponse response,
+      HttpServletRequest request) throws IOException {
+    User user = userService.retrieveTeacherByVerificationCode(code);
+    boolean verified = verifyTeacher(user);
+    String link = getLoginLink(user, verified);
+    sendWelcomeEmail(user, link, request);
+    response.sendRedirect(link);
+  }
+
+  private boolean verifyTeacher(User user) {
+    if (user != null) {
+      TeacherUserDetails tud = (TeacherUserDetails) user.getUserDetails();
+      return verifyTeacherAccount(user, tud);
+    } else {
+      return false;
+    }
+  }
+
+  private String getLoginLink(User user, boolean verified) {
+    StringBuilder link = new StringBuilder("/login?verified=");
+    link.append(user == null ? "error" : verified);
+    if (user != null) {
+      link.append("&username=").append(user.getUserDetails().getUsername());
+    }
+    return link.toString();
+  }
+
+  private void sendWelcomeEmail(User user, String link, HttpServletRequest request) {
+    if (link.contains("verified=true")) {
+      TeacherUserDetails tud = (TeacherUserDetails) user.getUserDetails();
+      this.teacherMailService.sendWelcomeEmail(tud.getEmailAddress(), tud.getDisplayname(), tud.getUsername(),
+          false, request.getLocale(), request);
+    }
+  }
+
+  private boolean verifyTeacherAccount(User user, TeacherUserDetails tud) {
+    if (!tud.isVerified()) {
+      tud.setVerified(true);
+      userService.updateUser(user);
+      return true;
+    } else {
+      return false;
+    }
+  }
+}

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

@@ -30,6 +30,7 @@
 import org.wise.portal.presentation.web.controllers.user.UserAPIController;
 import org.wise.portal.presentation.web.response.SimpleResponse;
 import org.wise.portal.service.authentication.UserDetailsService;
+import org.wise.portal.service.mail.teacher.TeacherMailService;
 import org.wise.portal.service.usertags.UserTagsService;
 
 /**
@@ -44,6 +45,9 @@
 @Secured({ "ROLE_TEACHER" })
 public class TeacherAPIController extends UserAPIController {
 
+  @Autowired
+  protected TeacherMailService teacherMailService;
+
   @Autowired
   private UserDetailsService userDetailsService;
 
@@ -326,4 +330,8 @@ HashMap<String, Object> editRunIsLockedAfterEndDate(Authentication authenticatio
     }
     return response;
   }
+
+  protected boolean isTeacher(User user) {
+    return user != null && !user.getRoles().contains("ROLE_STUDENT");
+  }
 }

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

@@ -3,7 +3,6 @@
 import java.util.Locale;
 import java.util.Map;
 
-import javax.mail.MessagingException;
 import javax.servlet.http.HttpServletRequest;
 
 import org.apache.commons.lang3.RandomStringUtils;
@@ -26,12 +25,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" })
@@ -44,67 +37,33 @@ ResponseEntity<Map<String, Object>> createTeacherAccount(
       return ResponseEntityGenerator.createError("recaptchaResponseInvalid");
     } catch (InvalidPasswordException e) {
       return ResponseEntityGenerator.createError(
-        passwordService.getErrors(teacherFields.get("password")));
+          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.teacherMailService.sendWelcomeEmail(tud.getEmailAddress(), tud.getDisplayname(), username, 
+          true, locale, request);
+    } else {
+      this.teacherMailService.sendVerifyEmail(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) 
-    throws RecaptchaVerificationException, InvalidNameException, InvalidPasswordException {
+      throws RecaptchaVerificationException, InvalidNameException, InvalidPasswordException {
     validateReCaptcha(teacherFields.get("token"));
     validateFirstAndLastName(teacherFields.get("firstName"), teacherFields.get("lastName"));
     validatePassword(teacherFields.get("password"));
@@ -119,7 +78,7 @@ private void validateReCaptcha(String token) throws RecaptchaVerificationExcepti
   }
 
   private void validateFirstAndLastName(String firstName, String lastName) 
-    throws InvalidNameException {
+      throws InvalidNameException {
     if (!isFirstNameAndLastNameValid(firstName, lastName)) {
       String messageCode = this.getInvalidNameMessageCode(firstName, lastName);
       throw new InvalidNameException(messageCode);
@@ -133,7 +92,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 +107,8 @@ private TeacherUserDetails createTeacherUserDetails(Map<String, String> teacherF
     tud.setLanguage(locale.getLanguage());
     setPassword(teacherFields, tud);
     tud.setEmailValid(true);
+    tud.setVerified(isSocialAccount || !teacherMailService.isSendEmailEnabled());
+    tud.setVerificationCode();
     return tud;
   }