From 29b4b80071d6c7f20e5526183a864982138a4523 Mon Sep 17 00:00:00 2001
From: Awiteb <a@4rs.nl>
Date: Mon, 12 Aug 2024 20:28:38 +0000
Subject: [PATCH] feat: Add case insensitive option to the captcha

Signed-off-by: Awiteb <a@4rs.nl>
---
 examples/simple_login.rs |  1 +
 src/lib.rs               | 19 ++++++++++++++++++-
 2 files changed, 19 insertions(+), 1 deletion(-)

diff --git a/examples/simple_login.rs b/examples/simple_login.rs
index 8ca1650..431f826 100644
--- a/examples/simple_login.rs
+++ b/examples/simple_login.rs
@@ -73,6 +73,7 @@ async fn main() {
         CaptchaBuilder::new(Arc::clone(&captcha_storage), CaptchaFormFinder::new())
             // Skip the captcha if the request path is /skipped
             .skipper(|req: &mut Request, _: &Depot| req.uri().path() == "/skipped")
+            .case_insensitive()
             .build();
 
     let router = Router::new()
diff --git a/src/lib.rs b/src/lib.rs
index e89b134..288707a 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -42,6 +42,8 @@ where
     storage: Arc<S>,
     /// The skipper of the captcha, used to skip the captcha check.
     skipper: Box<dyn Skipper>,
+    /// The case sensitive of the captcha answer.
+    case_sensitive: bool,
 }
 
 /// The captcha states of the request
@@ -75,6 +77,7 @@ where
     captcha_expired_after: Duration,
     clean_interval: Duration,
     skipper: Box<dyn Skipper>,
+    case_sensitive: bool,
 }
 
 impl<S, F> CaptchaBuilder<Arc<S>, F>
@@ -90,9 +93,18 @@ where
             captcha_expired_after: Duration::from_secs(60 * 5),
             clean_interval: Duration::from_secs(60),
             skipper: Box::new(none_skipper),
+            case_sensitive: true,
         }
     }
 
+    /// Remove the case sensitive of the captcha, default is case sensitive.
+    ///
+    /// This will make the captcha case insensitive, for example, the answer "Hello" will be the same as "hello".
+    pub fn case_insensitive(mut self) -> Self {
+        self.case_sensitive = false;
+        self
+    }
+
     /// Set the duration after which the captcha will be expired, default is 5 minutes.
     ///
     /// After the captcha is expired, it will be removed from the storage, and the user needs to get a new captcha.
@@ -125,6 +137,7 @@ where
             self.captcha_expired_after,
             self.clean_interval,
             self.skipper,
+            self.case_sensitive,
         )
     }
 }
@@ -141,6 +154,7 @@ where
         captcha_expired_after: Duration,
         clean_interval: Duration,
         skipper: Box<dyn Skipper>,
+        case_sensitive: bool,
     ) -> Self {
         let task_storage = Arc::clone(&storage);
 
@@ -157,6 +171,7 @@ where
             finder,
             storage,
             skipper,
+            case_sensitive,
         }
     }
 }
@@ -224,7 +239,9 @@ where
         match self.storage.get_answer(&token).await {
             Ok(Some(captch_answer)) => {
                 log::info!("Captcha answer is exist in storage for token: {token}");
-                if captch_answer == answer {
+                if (captch_answer == answer && self.case_sensitive)
+                    || captch_answer.eq_ignore_ascii_case(&answer)
+                {
                     log::info!("Captcha answer is correct for token: {token}");
                     self.storage.clear_by_token(&token).await.ok();
                     depot.insert(CAPTCHA_STATE_KEY, CaptchaState::Passed);