From 83c553b29bdbab725b3da14d30aba2577ca7a3b1 Mon Sep 17 00:00:00 2001
From: Ivan Mrsulja <mrsuljaivancic@gmail.com>
Date: Tue, 28 Nov 2023 18:51:55 +0100
Subject: [PATCH] Added refresh button for default challenge.

---
 .../beans/RefreshCaptchaController.java       | 31 +++++++++++++++++++
 .../freemarker/ContactFormController.java     |  1 +
 .../freemarker/ContactMailController.java     |  1 +
 .../body/contactForm/contactForm-form.ftl     | 29 ++++++++++++++++-
 .../freemarker/edit/forms/css/customForm.css  | 22 +++++++++++++
 5 files changed, 83 insertions(+), 1 deletion(-)
 create mode 100644 api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/RefreshCaptchaController.java

diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/RefreshCaptchaController.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/RefreshCaptchaController.java
new file mode 100644
index 0000000000..958183e00a
--- /dev/null
+++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/beans/RefreshCaptchaController.java
@@ -0,0 +1,31 @@
+package edu.cornell.mannlib.vitro.webapp.beans;
+
+import java.io.IOException;
+import java.io.PrintWriter;
+
+import javax.servlet.ServletException;
+import javax.servlet.annotation.WebServlet;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+import com.twelvemonkeys.servlet.HttpServlet;
+
+@WebServlet(name = "refreshCaptcha", urlPatterns = {"/refreshCaptcha"}, loadOnStartup = 5)
+public class RefreshCaptchaController extends HttpServlet {
+
+    protected void doGet(HttpServletRequest request, HttpServletResponse response)
+        throws ServletException, IOException {
+        String oldChallengeId = request.getParameter("oldChallengeId");
+
+        response.setContentType("application/json");
+        PrintWriter out = response.getWriter();
+
+        CaptchaBundle newChallenge = CaptchaServiceBean.generateChallenge();
+        CaptchaServiceBean.getCaptchaChallenges().invalidate(oldChallengeId);
+        CaptchaServiceBean.getCaptchaChallenges().put(newChallenge.getCaptchaId(), newChallenge);
+
+        out.println("{\"challenge\": \"" + newChallenge.getB64Image() + "\", \"challengeId\": \"" +
+            newChallenge.getCaptchaId() + "\"}");
+    }
+
+}
diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/freemarker/ContactFormController.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/freemarker/ContactFormController.java
index afebb46fe0..1d0ad6e1f0 100644
--- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/freemarker/ContactFormController.java
+++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/freemarker/ContactFormController.java
@@ -80,6 +80,7 @@ else if (StringUtils.isBlank(appBean.getContactMail())) {
                 body.put("challengeId", captchaChallenge.getCaptchaId());
             }
 
+            body.put("contextPath", vreq.getContextPath());
             body.put("formAction", "submitFeedback");
             body.put("captchaToUse", captchaImpl);
 
diff --git a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/freemarker/ContactMailController.java b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/freemarker/ContactMailController.java
index 20a49ba4aa..3910ddf0f0 100644
--- a/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/freemarker/ContactMailController.java
+++ b/api/src/main/java/edu/cornell/mannlib/vitro/webapp/controller/freemarker/ContactMailController.java
@@ -421,6 +421,7 @@ private ResponseValues errorParametersNotValid(String errorMsg, String webuserna
         body.put("webuseremail", webuseremail);
         body.put("comments", comments);
         body.put("captchaToUse", captchaImpl);
+        body.put("contextPath", vreq.getContextPath());
 
         if (!captchaImpl.equals("RECAPTCHA")) {
             CaptchaBundle captchaChallenge = CaptchaServiceBean.generateChallenge();
diff --git a/webapp/src/main/webapp/templates/freemarker/body/contactForm/contactForm-form.ftl b/webapp/src/main/webapp/templates/freemarker/body/contactForm/contactForm-form.ftl
index 29a4f9d8f1..80012d69b8 100644
--- a/webapp/src/main/webapp/templates/freemarker/body/contactForm/contactForm-form.ftl
+++ b/webapp/src/main/webapp/templates/freemarker/body/contactForm/contactForm-form.ftl
@@ -37,7 +37,11 @@
             <!-- Your custom captcha implementation -->
             <p>
                 <label class="realpersonLabel">${i18n().enter_in_security_field}:<span class="requiredHint"> *</span></label>
-                <img src="data:image/png;base64,${challenge!}" alt="Refresh page if not displayed..." style="vertical-align: middle;">
+                <div class="captcha-container">
+                    <span><input id="refresh" type="button" value="↻" /></span>
+                    <img id="captchaImage" src="data:image/png;base64,${challenge!}" alt="Refresh page if not displayed..." style="vertical-align: middle;">
+                </div>
+                <br />
                 <span><input type="text" id="userSolution" name="userSolution" style="vertical-align: middle;"></span>
                 <input type="text" id="challengeId" name="challengeId" value="${challengeId!}" style="display: none;">
             </p>
@@ -71,4 +75,27 @@ ${scripts.add('<script type="text/javascript" src="${urls.base}/js/commentForm.j
             document.getElementById('g-recaptcha-response').value = recaptchaResponse;
         });
     </script>
+<#else>
+    <script>
+        $(document).ready(function () {
+            $('#refresh').click(function () {
+                var oldChallengeId = $('#challengeId').val();
+
+                $.ajax({
+                    url: '${contextPath}/refreshCaptcha',
+                    type: 'GET',
+                    dataType: 'json',
+                    data: { oldChallengeId: oldChallengeId },
+                    success: function (data) {
+                        $('#userSolution').val('');
+                        $('#challengeId').val(data.challengeId);
+                        $('#captchaImage').attr('src', 'data:image/png;base64,' + data.challenge);
+                    },
+                    error: function () {
+                        console.error('Error while refreshing captcha');
+                    }
+                });
+            });
+        });
+    </script>
 </#if>
diff --git a/webapp/src/main/webapp/templates/freemarker/edit/forms/css/customForm.css b/webapp/src/main/webapp/templates/freemarker/edit/forms/css/customForm.css
index fe05157bf5..9172e67bd8 100644
--- a/webapp/src/main/webapp/templates/freemarker/edit/forms/css/customForm.css
+++ b/webapp/src/main/webapp/templates/freemarker/edit/forms/css/customForm.css
@@ -113,6 +113,28 @@ form.customForm label.dateTime {
 fieldset.dateTime select {
     margin-top: 0;
 }
+
+.captcha-container {
+    position: relative;
+    display: inline-block;
+}
+
+.captcha-container span {
+    position: absolute;
+    top: 0;
+    right: 0;
+    background: #ffffffeb;
+    color: #595b5b;
+    border: 1px solid #595b5b;
+    font-size: 0.8em;
+    padding: 0 8px;
+}
+
+.captcha-container span input {
+    border: 0;
+    background: transparent;
+}
+
 /* ---------------------------------- */
 /* ----- FOR MANAGE PUBLICATIONS ---- */
 /* ---------------------------------- */