From 0e79ed52680c594b36e5c8d934f5513071886945 Mon Sep 17 00:00:00 2001
From: mcalinghee <mcalinghee.dev@gmail.com>
Date: Thu, 5 Jun 2025 15:40:22 +0200
Subject: [PATCH] rename Login:EMAIL to Login::Email + remove use of email
 prefix

---
 crates/data-model/Cargo.toml                  |  4 +-
 .../src/oauth2/authorization_grant.rs         | 37 +++++++++++--------
 crates/handlers/src/views/login.rs            |  2 +-
 3 files changed, 25 insertions(+), 18 deletions(-)

diff --git a/crates/data-model/Cargo.toml b/crates/data-model/Cargo.toml
index 2a152a296..ad3a9848b 100644
--- a/crates/data-model/Cargo.toml
+++ b/crates/data-model/Cargo.toml
@@ -29,9 +29,9 @@ rand.workspace = true
 regex.workspace = true
 woothee.workspace = true
 ruma-common.workspace = true
+lettre.workspace = true
 
 mas-iana.workspace = true
 mas-jose.workspace = true
 oauth2-types.workspace = true
-# Emails
-lettre.workspace = true
+
diff --git a/crates/data-model/src/oauth2/authorization_grant.rs b/crates/data-model/src/oauth2/authorization_grant.rs
index b5a83c80a..8f8423623 100644
--- a/crates/data-model/src/oauth2/authorization_grant.rs
+++ b/crates/data-model/src/oauth2/authorization_grant.rs
@@ -144,7 +144,7 @@ impl AuthorizationGrantStage {
 
 pub enum LoginHint<'a> {
     MXID(&'a UserId),
-    EMAIL(lettre::Address),
+    Email(lettre::Address),
     None,
 }
 
@@ -175,14 +175,31 @@ impl std::ops::Deref for AuthorizationGrant {
 }
 
 impl AuthorizationGrant {
+    /// Parse a `login_hint`
+    ///
+    /// Returns `LoginHint::MXID` for valid mxid 'mxid:@john.doe:example.com'
+    ///
+    /// Returns `LoginHint::Email` for valid email 'john.doe@example.com' if
+    /// email supports is enabled
+    ///
+    /// Otherwise returns `LoginHint::None`
     #[must_use]
     pub fn parse_login_hint(&self, homeserver: &str, login_with_email_allowed: bool) -> LoginHint {
         let Some(login_hint) = &self.login_hint else {
             return LoginHint::None;
         };
 
-        // Return none if the format is incorrect
         let Some((prefix, value)) = login_hint.split_once(':') else {
+            // If email supports for login_hint is enabled
+            if login_with_email_allowed {
+                // Validate the email
+                let Ok(address) = lettre::Address::from_str(login_hint) else {
+                    // Return none if the format is incorrect
+                    return LoginHint::None;
+                };
+                return LoginHint::Email(address);
+            }
+            // Unknown hint type, treat as none
             return LoginHint::None;
         };
 
@@ -200,16 +217,6 @@ impl AuthorizationGrant {
 
                 LoginHint::MXID(mxid)
             }
-            "email" => {
-                if !login_with_email_allowed {
-                    return LoginHint::None;
-                }
-                // Validate the email
-                let Ok(address) = lettre::Address::from_str(value) else {
-                    return LoginHint::None;
-                };
-                LoginHint::EMAIL(address)
-            }
             // Unknown hint type, treat as none
             _ => LoginHint::None,
         }
@@ -333,13 +340,13 @@ mod tests {
         let now = Utc::now();
 
         let grant = AuthorizationGrant {
-            login_hint: Some(String::from("email:example@user")),
+            login_hint: Some(String::from("example@user")),
             ..AuthorizationGrant::sample(now, &mut rng)
         };
 
         let hint = grant.parse_login_hint("example.com", true);
 
-        assert!(matches!(hint, LoginHint::EMAIL(email) if email.to_string() == "example@user"));
+        assert!(matches!(hint, LoginHint::Email(email) if email.to_string() == "example@user"));
     }
 
     #[test]
@@ -351,7 +358,7 @@ mod tests {
         let now = Utc::now();
 
         let grant = AuthorizationGrant {
-            login_hint: Some(String::from("email:example@user")),
+            login_hint: Some(String::from("example@user")),
             ..AuthorizationGrant::sample(now, &mut rng)
         };
 
diff --git a/crates/handlers/src/views/login.rs b/crates/handlers/src/views/login.rs
index 307898c43..fc979d932 100644
--- a/crates/handlers/src/views/login.rs
+++ b/crates/handlers/src/views/login.rs
@@ -392,7 +392,7 @@ fn handle_login_hint(
             site_config.login_with_email_allowed,
         ) {
             LoginHint::MXID(mxid) => Some(mxid.localpart().to_owned()),
-            LoginHint::EMAIL(email) => Some(email.to_string()),
+            LoginHint::Email(email) => Some(email.to_string()),
             LoginHint::None => None,
         };
         form_state.set_value(LoginFormField::Username, value);