(#322) SharpXmppHelper: sanitize text on the outgoing XML

Author: ForNeVeR

Emulsion.Tests/Xmpp/SharpXmppHelperTests.fs

@@ -1,4 +1,4 @@
-// SPDX-FileCopyrightText: 2024 Emulsion contributors <https://github.com/codingteam/emulsion>
+// SPDX-FileCopyrightText: 2025 Emulsion contributors <https://github.com/codingteam/emulsion>
 //
 // SPDX-License-Identifier: MIT
 
@@ -16,6 +16,22 @@ open Emulsion.Xmpp
 open Emulsion.Xmpp.SharpXmppHelper.Attributes
 open Emulsion.Xmpp.SharpXmppHelper.Elements
 
+[<Fact>]
+let ``SanitizeXmlText processes emoji as-is``(): unit =
+    Assert.Equal("🐙", SharpXmppHelper.SanitizeXmlText "🐙")
+    Assert.Equal("test🐙", SharpXmppHelper.SanitizeXmlText "test🐙")
+
+[<Fact>]
+let ``SanitizeXmlText replaces parts of UTF-16 surrogate pair with the replacement char``(): unit =
+    let octopus = "🐙"
+    Assert.Equal(2, octopus.Length)
+    let firstHalf = string(octopus[0])
+    let secondHalf = string(octopus[1])
+    Assert.Equal("🐙", firstHalf + secondHalf)
+    Assert.Equal("�", SharpXmppHelper.SanitizeXmlText firstHalf)
+    Assert.Equal("�", SharpXmppHelper.SanitizeXmlText secondHalf)
+    Assert.Equal("test�", SharpXmppHelper.SanitizeXmlText $"test{secondHalf}")
+
 [<Fact>]
 let ``Message body has a proper namespace``() =
     let message = SharpXmppHelper.message "" "cthulhu@test" "text"

Emulsion/Xmpp/SharpXmppHelper.fs

@@ -1,13 +1,16 @@
-// SPDX-FileCopyrightText: 2024 Emulsion contributors <https://github.com/codingteam/emulsion>
+// SPDX-FileCopyrightText: 2025 Emulsion contributors <https://github.com/codingteam/emulsion>
 //
 // SPDX-License-Identifier: MIT
 
 /// Helper functions to deal with SharpXMPP low-level details (such as XML stuff).
 module Emulsion.Xmpp.SharpXmppHelper
 
 open System
+open System.Buffers
+open System.Text
 open System.Xml.Linq
 
+open Microsoft.FSharp.NativeInterop
 open SharpXMPP
 open SharpXMPP.XMPP
 open SharpXMPP.XMPP.Client.Elements
@@ -49,6 +52,28 @@ let private bookmark (roomJid: string) (nickname: string) (password: string opti
     room.Add(nickElement)
     room
 
+#nowarn "9" // for NativePtr
+let SanitizeXmlText(text: string): string =
+    let mutable hasError = false
+    let mutable span = text.AsSpan()
+    while not hasError && not span.IsEmpty do
+        let mutable rune = Rune()
+        let mutable consumed = 0
+        if Rune.DecodeFromUtf16(span, &rune, &consumed) = OperationStatus.Done
+        then span <- span.Slice consumed
+        else hasError <- true
+
+    if hasError then
+        let builder = StringBuilder()
+        for r in text.EnumerateRunes() do
+            let length = r.Utf16SequenceLength
+            let buf = Span(NativePtr.stackalloc<char> length |> NativePtr.toVoidPtr, length)
+            r.EncodeToUtf16 buf |> ignore
+            builder.Append(buf) |> ignore
+        builder.ToString()
+    else
+        text
+
 let joinRoom (client: XmppClient) (roomJid: string) (nickname: string) (password: string option): unit =
     let room = bookmark roomJid nickname password
     client.BookmarkManager.Join room
@@ -59,7 +84,7 @@ let message (id: string) (toAddr: string) (text: string): XMPPMessage =
     m.SetAttributeValue(Type, "groupchat")
     m.SetAttributeValue(To, toAddr)
     let body = XElement(Body)
-    body.Value <- text
+    body.Value <- SanitizeXmlText text
     m.Add(body)
     m