Add support for additional replacement characers

Author: kdumontnu

custom/conf/app.example.ini

@@ -1527,8 +1527,8 @@ LEVEL = Info
 ;; email = use the username part of the email attribute
 ;; Note: `nickname` and `email` options will normalize input strings using the following criteria:
 ;; - diacritics are removed
-;; - single-quotes are removed
-;; - the characters set `\s,` is replaced with `-`
+;; - the characters set `[´\x60]` are removed
+;; - the characters set `[\s~+]` is replaced with `-`
 ;USERNAME = nickname
 ;;
 ;; Update avatar if available from oauth2 provider.

docs/content/administration/config-cheat-sheet.en-us.md

@@ -600,8 +600,8 @@ And the following unique queues:
   - `email` - use the username part of the email attribute
   - Note: `nickname` and `email` options will normalize input strings using the following criteria:
     - diacritics are removed
-    - single-quotes are removed
-    - the characters set `\s,` is replaced with `-`
+    - the characters set `[´\x60]` are removed
+    - the characters set `[\s~+]` is replaced with `-`
 - `UPDATE_AVATAR`: **false**: Update avatar if available from oauth2 provider. Update will be performed on each login.
 - `ACCOUNT_LINKING`: **login**: How to handle if an account / email already exists:
   - disabled - show an error

models/user/user.go

@@ -523,20 +523,21 @@ func GetUserSalt() (string, error) {
 // Note: The set of characters here can safely expand without a breaking change,
 // but characters removed from this set can cause user account linking to break
 var (
-	removeCharsRE             = regexp.MustCompile(`['\x60]`)
+	customCharsReplacement    = strings.NewReplacer("Æ", "AE")
+	removeCharsRE             = regexp.MustCompile(`['´\x60]`)
 	removeDiacriticsTransform = transform.Chain(norm.NFD, runes.Remove(runes.In(unicode.Mn)), norm.NFC)
-	replaceCharsRE            = regexp.MustCompile(`[\s,]`)
+	replaceCharsHyphenRE      = regexp.MustCompile(`[\s~+]`)
 )
 
 // normalizeUserName returns a string with single-quotes and diacritics
 // removed, and any other non-supported username characters replaced with
 // a `-` character
 func NormalizeUserName(s string) (string, error) {
-	strDiacriticsRemoved, n, err := transform.String(removeDiacriticsTransform, s)
+	strDiacriticsRemoved, n, err := transform.String(removeDiacriticsTransform, customCharsReplacement.Replace(s))
 	if err != nil {
 		return "", fmt.Errorf("Failed to normalize character `%v` in provided username `%v`", s[n], s)
 	}
-	return replaceCharsRE.ReplaceAllLiteralString(removeCharsRE.ReplaceAllLiteralString(strDiacriticsRemoved, ""), "-"), nil
+	return replaceCharsHyphenRE.ReplaceAllLiteralString(removeCharsRE.ReplaceAllLiteralString(strDiacriticsRemoved, ""), "-"), nil
 }
 
 var (

models/user/user_test.go

@@ -553,13 +553,13 @@ func Test_NormalizeUserFromEmail(t *testing.T) {
 	}{
 		{"test", "test", true},
 		{"Sinéad.O'Connor", "Sinead.OConnor", true},
-		{"Æsir", "Æsir", false}, // Currently unsupported
+		{"Æsir", "AEsir", true},
 		// \u00e9\u0065\u0301
 		{"éé", "ee", true},
 		{"Awareness Hub", "Awareness-Hub", true},
 		{"double__underscore", "double__underscore", false}, // We should consider squashing double non-alpha characters
 		{".bad.", ".bad.", false},
-		{"new😀user", "new😀user", false},
+		{"new😀user", "new😀user", false}, // No plans to support
 	}
 	for _, testCase := range testCases {
 		normalizedName, err := user_model.NormalizeUserName(testCase.Input)