add filters for legacy email and legacy localpart (#7)

Author: odelcroi

Cargo.lock

@@ -62,6 +62,7 @@ mas-templates = { path = "./crates/templates/", version = "=0.17.0-rc.0" }
 mas-tower = { path = "./crates/tower/", version = "=0.17.0-rc.0" }
 oauth2-types = { path = "./crates/oauth2-types/", version = "=0.17.0-rc.0" }
 syn2mas = { path = "./crates/syn2mas", version = "=0.17.0-rc.0" }
+tchap = { path = "./crates/tchap", version = "=0.1.0" }
 
 # OpenAPI schema generation and validation
 [workspace.dependencies.aide]

Cargo.toml

@@ -87,6 +87,8 @@ mas-templates.workspace = true
 oauth2-types.workspace = true
 zxcvbn.workspace = true
 
+tchap.workspace = true
+
 [dev-dependencies]
 insta.workspace = true
 tracing-subscriber.workspace = true

crates/handlers/Cargo.toml

@@ -11,6 +11,7 @@ use minijinja::{
     Environment, Error, ErrorKind, Value,
     value::{Enumerator, Object},
 };
+use tchap;
 
 /// Context passed to the attribute mapping template
 ///
@@ -188,6 +189,16 @@ pub fn environment() -> Environment<'static> {
     env.add_filter("string", string);
     env.add_filter("from_json", from_json);
 
+    // Add Tchap-specific filters, this could be a generic config submitted
+    // to upstream allowing all users to add their own filters without upstream code
+    // modifications tester les fonctions async pour le reseau
+    env.add_filter("email_to_display_name", |s: &str| {
+        tchap::email_to_display_name(s)
+    });
+    env.add_filter("email_to_mxid_localpart", |s: &str| {
+        tchap::email_to_mxid_localpart(s)
+    });
+
     env.set_unknown_method_callback(minijinja_contrib::pycompat::unknown_method_callback);
 
     env

crates/handlers/src/upstream_oauth2/template.rs

@@ -0,0 +1,7 @@
+[package]
+name = "tchap"
+version = "0.1.0"
+description = "Tchap-specific functionality for Matrix Authentication Service"
+license = "MIT"
+
+[dependencies]

crates/tchap/Cargo.toml

@@ -0,0 +1,210 @@
+// Copyright 2025 New Vector Ltd.
+//
+// SPDX-License-Identifier: AGPL-3.0-only
+// Please see LICENSE in the repository root for full details.
+
+//! Tchap-specific functionality for Matrix Authentication Service
+
+/// Capitalise parts of a name containing different words, including those
+/// separated by hyphens.
+///
+/// For example, 'John-Doe'
+///
+/// # Parameters
+///
+/// * `name`: The name to parse
+///
+/// # Returns
+///
+/// The capitalized name
+#[must_use]
+pub fn cap(name: &str) -> String {
+    if name.is_empty() {
+        return name.to_string();
+    }
+
+    // Split the name by whitespace then hyphens, capitalizing each part then
+    // joining it back together.
+    let capitalized_name = name
+        .split_whitespace()
+        .map(|space_part| {
+            space_part
+                .split('-')
+                .map(|part| {
+                    let mut chars = part.chars();
+                    match chars.next() {
+                        None => String::new(),
+                        Some(first_char) => {
+                            let first_char_upper = first_char.to_uppercase().collect::<String>();
+                            let rest: String = chars.collect();
+                            format!("{}{}", first_char_upper, rest)
+                        }
+                    }
+                })
+                .collect::<Vec<String>>()
+                .join("-")
+        })
+        .collect::<Vec<String>>()
+        .join(" ");
+
+    capitalized_name
+}
+
+/// Generate a Matrix ID localpart from an email address.
+///
+/// This function:
+/// 1. Replaces "@" with "-" in the email address
+/// 2. Converts the email to lowercase
+/// 3. Filters out any characters that are not allowed in a Matrix ID localpart
+///
+/// The allowed characters are: lowercase ASCII letters, digits, and "_-./="
+///
+/// # Parameters
+///
+/// * `address`: The email address to process
+///
+/// # Returns
+///
+/// A valid Matrix ID localpart derived from the email address
+#[must_use]
+pub fn email_to_mxid_localpart(address: &str) -> String {
+    // Define the allowed characters for a Matrix ID localpart
+    const ALLOWED_CHARS: &str = "abcdefghijklmnopqrstuvwxyz0123456789_-./=";
+
+    // Replace "@" with "-" and convert to lowercase
+    let processed = address.replace('@', "-").to_lowercase();
+
+    // Filter out any characters that are not allowed
+    processed
+        .chars()
+        .filter(|c| ALLOWED_CHARS.contains(*c))
+        .collect()
+}
+
+/// Generate a display name from an email address based on specific rules.
+///
+/// This function:
+/// 1. Replaces dots with spaces in the username part
+/// 2. Determines the organization based on domain rules:
+///    - gouv.fr emails use the subdomain or "gouv" if none
+///    - other emails use the second-level domain
+/// 3. Returns a display name in the format "Username [Organization]"
+///
+/// # Parameters
+///
+/// * `address`: The email address to process
+///
+/// # Returns
+///
+/// The formatted display name
+#[must_use]
+pub fn email_to_display_name(address: &str) -> String {
+    // Split the part before and after the @ in the email.
+    // Replace all . with spaces in the first part
+    let parts: Vec<&str> = address.split('@').collect();
+    if parts.len() != 2 {
+        return String::new();
+    }
+
+    let username = parts[0].replace('.', " ");
+    let domain = parts[1];
+
+    // Figure out which org this email address belongs to
+    let domain_parts: Vec<&str> = domain.split('.').collect();
+
+    let org = if domain_parts.len() >= 2
+        && domain_parts[domain_parts.len() - 2] == "gouv"
+        && domain_parts[domain_parts.len() - 1] == "fr"
+    {
+        // Is this is a ...gouv.fr address, set the org to whatever is before
+        // gouv.fr. If there isn't anything (a @gouv.fr email) simply mark their
+        // org as "gouv"
+        if domain_parts.len() > 2 {
+            domain_parts[domain_parts.len() - 3]
+        } else {
+            "gouv"
+        }
+    } else if domain_parts.len() >= 2 {
+        // Otherwise, mark their org as the email's second-level domain name
+        domain_parts[domain_parts.len() - 2]
+    } else {
+        ""
+    };
+
+    // Format the display name
+    format!("{} [{}]", cap(&username), cap(org))
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_cap() {
+        assert_eq!(cap("john"), "John");
+        assert_eq!(cap("john-doe"), "John-Doe");
+        assert_eq!(cap("john doe"), "John Doe");
+        assert_eq!(cap("john-doe smith"), "John-Doe Smith");
+        assert_eq!(cap(""), "");
+    }
+
+    #[test]
+    fn test_email_to_display_name() {
+        // Test gouv.fr email with subdomain
+        assert_eq!(
+            email_to_display_name("[email protected]"),
+            "Jane Smith [Example]"
+        );
+
+        // Test gouv.fr email without subdomain
+        assert_eq!(email_to_display_name("[email protected]"), "User [Gouv]");
+
+        // Test gouv.fr email with subdomain
+        assert_eq!(
+            email_to_display_name("[email protected]"),
+            "User [Gendarmerie]"
+        );
+
+        // Test gouv.fr email with subdomain
+        assert_eq!(
+            email_to_display_name("[email protected]"),
+            "User [Interieur]"
+        );
+
+        // Test regular email
+        assert_eq!(
+            email_to_display_name("[email protected]"),
+            "Contact [Example]"
+        );
+
+        // Test invalid email
+        assert_eq!(email_to_display_name("invalid-email"), "");
+    }
+
+    #[test]
+    fn test_email_to_mxid_localpart() {
+        // Test basic email
+        assert_eq!(
+            email_to_mxid_localpart("[email protected]"),
+            "john.doe-example.com"
+        );
+
+        // Test with uppercase letters
+        assert_eq!(
+            email_to_mxid_localpart("[email protected]"),
+            "john.doe-example.com"
+        );
+
+        // Test with special characters
+        assert_eq!(
+            email_to_mxid_localpart("[email protected]"),
+            "usertag-domain.com"
+        );
+
+        // Test with invalid characters
+        assert_eq!(
+            email_to_mxid_localpart("user!#$%^&*()@domain.com"),
+            "user-domain.com"
+        );
+    }
+}