Fix username escape

Author: linyinfeng

Cargo.lock

@@ -1,7 +1,7 @@
 [package]
 name = "commit-notifier"
 authors = [ "Lin Yinfeng <[email protected]>" ]
-version = "0.2.1"
+version = "0.2.2"
 edition = "2024"
 description = """
 A simple bot tracking git commits/PRs/issues/branches

Cargo.toml

@@ -88,7 +88,7 @@ impl TryFrom<SubscriberCompat> for Subscriber {
                     markdown_mention: mention.clone(),
                 }),
                 (_, Some(username)) => Ok(Subscriber::Telegram {
-                    markdown_mention: format!("@{username}"),
+                    markdown_mention: format!("@{}", markdown::escape(username)),
                 }),
                 (_, _) => Err(Error::InvalidSubscriber(compat)),
             },
@@ -105,9 +105,14 @@ pub enum SubscriberCompat {
 }
 
 impl Subscriber {
-    pub fn from_tg_user(u: &User) -> Self {
+    pub fn from_tg_user(user: &User) -> Self {
+        // `markdown::user_mention_or_link` does not escape `user.mention()`
+        let mention = match user.mention() {
+            Some(mention) => markdown::escape(&mention),
+            None => markdown::link(user.url().as_str(), &markdown::escape(&user.full_name())),
+        };
         Self::Telegram {
-            markdown_mention: markdown::user_mention_or_link(u),
+            markdown_mention: mention,
         }
     }
 

src/chat/settings.rs

@@ -4,6 +4,7 @@ mod condition;
 mod error;
 mod github;
 mod message;
+mod migration;
 mod options;
 mod repo;
 mod resources;
@@ -167,6 +168,9 @@ async fn version_check() -> Result<(), Error> {
                 version_info.version,
             ));
         }
+        if old_version == version_compare::Version::from("0.2.1").unwrap() {
+            migration::from_0_2_1().await?;
+        }
     } else {
         // do nothing, start from an empty configuration
     }

src/main.rs

@@ -0,0 +1,68 @@
+use std::{collections::BTreeSet, mem};
+
+use teloxide::utils::markdown;
+
+use crate::{
+    chat::{
+        self,
+        settings::{NotifySettings, Subscriber},
+    },
+    error::Error,
+};
+
+pub async fn from_0_2_1() -> Result<(), Error> {
+    fn migrate_notify_settings(settings: &mut NotifySettings) {
+        let mut subscribers = BTreeSet::new();
+        mem::swap(&mut subscribers, &mut settings.subscribers);
+        for subscriber in subscribers {
+            match subscriber {
+                Subscriber::Telegram { markdown_mention } => {
+                    if markdown_mention.starts_with("@") {
+                        let new_mention = markdown::escape(&markdown_mention);
+                        if new_mention != markdown_mention {
+                            log::info!("escape username '{markdown_mention}' to '{new_mention}'");
+                        }
+                        settings.subscribers.insert(Subscriber::Telegram {
+                            markdown_mention: new_mention,
+                        });
+                    } else {
+                        settings
+                            .subscribers
+                            .insert(Subscriber::Telegram { markdown_mention });
+                    }
+                }
+            }
+        }
+    }
+
+    log::info!("migration from version 0.2.1");
+    let chats = chat::chats().await?;
+    for chat in chats.iter().cloned() {
+        log::info!("migrating chat {chat}...");
+        let repos = chat::repos(chat).await?;
+        for repo in repos {
+            log::info!("migrating repo {chat}/{repo}...");
+            let resources = chat::resources_chat_repo(chat, repo.to_string()).await?;
+            let mut settings = resources.settings.write().await;
+            for (_, settings) in settings.branches.iter_mut() {
+                migrate_notify_settings(&mut settings.notify)
+            }
+            for (_, settings) in settings.commits.iter_mut() {
+                migrate_notify_settings(&mut settings.notify)
+            }
+            for (_, settings) in settings.pr_issues.iter_mut() {
+                migrate_notify_settings(&mut settings.notify)
+            }
+        }
+    }
+
+    // no errors, save all settings at once
+    for chat in chats {
+        let repos = chat::repos(chat).await?;
+        for repo in repos {
+            let resources = chat::resources_chat_repo(chat, repo.to_string()).await?;
+            resources.save_settings().await?;
+        }
+    }
+    Ok(())
+}