Pinging discord users #2

New Issue

jshiffer · 2025-02-22T14:14:37-08:00

jshiffer commented

2025-02-22 14:14:37 -08:00

If XMPP users ping discord users, and it's followed by punctuation, it won't work
e.g. @scoliono,

If XMPP users ping discord users, and it's followed by punctuation, it won't work e.g. `@scoliono,`

di-gital commented

2025-02-27 13:22:27 -08:00

Pinging also does not work if a ping is preceded by punctuation, as in (@example).

The problem how the Matterbridge uses regular expressions to scan for a Discord username. The relevant functions and definitions are contained in bridge/discord/helpers.go.

Line 163:

userMentionRE    = regexp.MustCompile("@[^@\n]{1,32}")

The regex will only compile if it encounters a string that is precisely a username. A more reasonable regex may look like:

userMentionRE    = regexp.MustCompile("\(*@[^@\n]{1,32}(\'s)?(\,|\:|;|\))*")

Which matches @example, @example;, @example:, @example's, (@example), and (@example's). It may be mechanically explained as (courtesy of this online tool)

- Exactly once: All of:
  -1. Zero or more times: Match '('
  -2. Exactly once: Match '@'
  -3. {1,32} times: Match '[^@\n]'
  -4. Optional: Subexpression: Exactly once: All of:
      1. Exactly once: Match '''
      2. Exactly once: Match 's'
  -5. Zero or more times: Subexpression: Exactly once: One of:
      1. Exactly once: Match ','
      2. Exactly once: Match ':'
      3. Exactly once: Match ';'
      4. Exactly once: Match ')'

This, however, only finds strings that are syntactically valid for adding a ping. The code will also have to extract the username from the string and use that to provide a ping.

Pinging also does not work if a ping is preceded by punctuation, as in `(@example)`. The problem how the Matterbridge uses regular expressions to scan for a Discord username. The relevant functions and definitions are contained in `bridge/discord/helpers.go`. Line 163: ```go userMentionRE = regexp.MustCompile("@[^@\n]{1,32}") ``` The regex will only compile if it encounters a string that is _precisely_ a username. A more reasonable regex may look like: ```go userMentionRE = regexp.MustCompile("\(*@[^@\n]{1,32}(\'s)?(\,|\:|;|\))*") ``` Which matches `@example`, `@example;`, `@example:`, `@example's`, `(@example)`, and `(@example's)`. It may be mechanically explained as (courtesy of [this online tool](https://www.mobzystems.com/online/explain-regular-expression/)) ``` - Exactly once: All of: -1. Zero or more times: Match '(' -2. Exactly once: Match '@' -3. {1,32} times: Match '[^@\n]' -4. Optional: Subexpression: Exactly once: All of: 1. Exactly once: Match ''' 2. Exactly once: Match 's' -5. Zero or more times: Subexpression: Exactly once: One of: 1. Exactly once: Match ',' 2. Exactly once: Match ':' 3. Exactly once: Match ';' 4. Exactly once: Match ')' ``` This, however, only finds strings that are syntactically valid for adding a ping. The code will also have to extract the username from the string and use that to provide a ping.

di-gital referenced this issue

2025-02-27 13:26:47 -08:00

Update userMentionRE to play nice with punctuation. #7

Sign in to join this conversation.

Branches Tags

2 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: lug/matterbridge#2