Some fixes + code review

Author: qtipee

jamais404/src/main/java/com/jamais404/Handle404Controller.java

@@ -31,46 +31,53 @@ public class Handle404Controller implements ErrorController {
     private PageRepository pageRepository;
 
     /**
-     * Handles every route different from the ones registered in the HomeController.
+     * Handles every route different from the ones registered.
+     * This is the way of not throwing a 404 error.
      * 
      * @param model
      * @param request
      * @return
      */
     @RequestMapping("/error")
-    public String handleError(Model model, HttpServletRequest request,
-        Authentication authentication,
+    public String handleError(Model model, HttpServletRequest request, Authentication authentication,
         @RequestParam(value = "msg", defaultValue = "") String msg) {
         model.addAttribute("active", authentication.getName());
 
         // Gets the URI that triggered the 404 error (to avoid /error)
         String originalUri = request.getAttribute(RequestDispatcher.FORWARD_REQUEST_URI).toString();
+        // Fetches the user pages names (sorted by alphabetical order)
         String parsedUri = originalUri.replace("/", "");
+        
         model.addAttribute("url", parsedUri);
 
         Page page = pageRepository.findByName(parsedUri);
 
+        // The page is already found by a user
         if (page != null) {
             String ownerUsername = page.getOwner().getUsername();
             Timestamp datetime = page.getDatetime();
+            // Parses the page timestamp into a more readable format
             String stringDatetime = TimeStampTools.timeStampToString(datetime);
 
             model.addAttribute("datetime", stringDatetime);
 
+            // Page found the current user
             if (ownerUsername.equals(authentication.getName())) {
                 model.addAttribute("username", "you");
                 model.addAttribute("userLink", authentication.getName());
             } else {
+                // Page found another user than the current one
                 model.addAttribute("username", ownerUsername);
                 model.addAttribute("userLink", ownerUsername);
             }
 
+            // Fetches the page comments (sorted by DESC timestamps)
             List<Comment> comments = page.getComments()
                 .stream()
                 .parallel()
                 .sorted((c1, c2) -> - c1.getDatetime().compareTo(c2.getDatetime()))
                 .collect(Collectors.toList());
-            
+
             model.addAttribute("comments", comments);
 
             // Message - from the submission of a comment - to display in a toast
@@ -80,6 +87,7 @@ public String handleError(Model model, HttpServletRequest request,
             return "already_found404";
         }
 
+        // New page found ; added to the current user
         User owner = userRepository.findByUsername(authentication.getName());
 
         page = new Page();
@@ -92,6 +100,7 @@ public String handleError(Model model, HttpServletRequest request,
 
     @Override
     public String getErrorPath() {
+        // Cannot omit this overriden method
         return "getErrorPath";
     }
 }

jamais404/src/main/java/com/jamais404/HomeController.java

@@ -45,6 +45,7 @@ public String home(Model model, Authentication authentication) {
 	 */
 	@PostMapping(value = "/search")
 	public ModelAndView search(@RequestParam String query, Authentication authentication) {
+        // Trims the slashes ; they cause troubles with the URLs
 		String redirectUrl = "redirect:/" + query.replace("/", "");
 
 		return new ModelAndView(redirectUrl);
@@ -61,6 +62,7 @@ public String user(Model model, @RequestParam String username, Authentication au
 
         User user = userRepository.findByUsername(username);
 
+        // Fetches the user pages names (sorted by alphabetical order)
         Set<String> pagesNames = user.getPages()
             .stream()
             .parallel()
@@ -79,8 +81,10 @@ public String user(Model model, @RequestParam String username, Authentication au
 	public ModelAndView comment(Model model, @RequestParam String text, @RequestParam String url, Authentication authentication) {
         User user = userRepository.findByUsername(authentication.getName());
         Page page = pageRepository.findByName(url);
+        // If the user has modified the HTML or JS before submitting a comment
         String msg = "Do not modify the code !";
 
+        // The page must exist (be found) in order to add a comment to it
         if (page != null) {
             Comment comment = new Comment();
             comment.setText(text);
@@ -91,6 +95,7 @@ public ModelAndView comment(Model model, @RequestParam String text, @RequestPara
             msg = "Comment added !";
         }
 
+        // Refreshes the page and shows a message in a toast
         String redirectUrl = "redirect:" + url + "?msg=" + msg;
 
 		return new ModelAndView(redirectUrl);

jamais404/src/main/java/com/jamais404/auth/validator/UserValidator.java

@@ -32,7 +32,6 @@ public boolean supports(Class<?> aClass) {
     public void validate(Object o, Errors errors) {
         User user = (User) o;
 
-
         // Email
         ValidationUtils.rejectIfEmptyOrWhitespace(errors, EMAIL_STRING, NOT_EMPTY_STRING);
         Matcher matcher = VALID_EMAIL_ADDRESS_REGEX.matcher(user.getEmail());

jamais404/src/main/resources/templates/already_found404.html

@@ -46,7 +46,7 @@ <h2 class="subtitle">Comments</h2>
 
                     <ul class="comments">
                         <li th:each="comment : ${comments}">
-                            <p class="text comment-info"><a th:href="@{'user?username=' + ${comment.user.username}}" class="pink-text text-darken-2" th:utext="${comment.user.username + ' '}"></a><span th:utext="${comment.datetime}"></span></p>
+                            <p class="text comment-info"><a th:href="@{'user?username=' + ${comment.user.username}}" class="pink-text text-darken-2" th:utext="${comment.user.username + ' '}"></a><span class="datetime" th:utext="${comment.datetime}"></span></p>
                             <p class="text comment-text grey-text" th:utext="${comment.text}"></p>
                         </li>
                     </ul>
@@ -103,6 +103,23 @@ <h2 class="subtitle">Don't give up !</h2>
             }
         })
     </script>
+        
+    <script>
+        document.addEventListener('DOMContentLoaded', (evt) => {
+            document.querySelectorAll('.datetime').forEach(datetime => {
+                // Formats the comments timestamps to more readable dates and times
+                let cutDatetime = datetime.innerHTML.match(/\S+/g) || []
+                let date = cutDatetime[0]
+                let time = cutDatetime[1]
+
+                date = date.split('-').reverse().join('.')
+                time = time.substring(0, time.indexOf('.'))
+                time = time.substring(0, time.length - 3)
+                
+                datetime.innerHTML = 'on ' + date + ' at ' + time
+            })
+        })
+    </script>
 
     <footer></footer>
 

jamais404/target/classes/templates/already_found404.html

@@ -46,7 +46,7 @@ <h2 class="subtitle">Comments</h2>
 
                     <ul class="comments">
                         <li th:each="comment : ${comments}">
-                            <p class="text comment-info"><a th:href="@{'user?username=' + ${comment.user.username}}" class="pink-text text-darken-2" th:utext="${comment.user.username + ' '}"></a><span th:utext="${comment.datetime}"></span></p>
+                            <p class="text comment-info"><a th:href="@{'user?username=' + ${comment.user.username}}" class="pink-text text-darken-2" th:utext="${comment.user.username + ' '}"></a><span class="datetime" th:utext="${comment.datetime}"></span></p>
                             <p class="text comment-text grey-text" th:utext="${comment.text}"></p>
                         </li>
                     </ul>
@@ -103,6 +103,23 @@ <h2 class="subtitle">Don't give up !</h2>
             }
         })
     </script>
+        
+    <script>
+        document.addEventListener('DOMContentLoaded', (evt) => {
+            document.querySelectorAll('.datetime').forEach(datetime => {
+                // Formats the comments timestamps to more readable dates and times
+                let cutDatetime = datetime.innerHTML.match(/\S+/g) || []
+                let date = cutDatetime[0]
+                let time = cutDatetime[1]
+
+                date = date.split('-').reverse().join('.')
+                time = time.substring(0, time.indexOf('.'))
+                time = time.substring(0, time.length - 3)
+                
+                datetime.innerHTML = 'on ' + date + ' at ' + time
+            })
+        })
+    </script>
 
     <footer></footer>