Escape vCard fields

Author: hamorillo

homeUi/src/main/kotlin/com/gravatar/app/homeUi/presentation/home/share/model/VCard.kt

@@ -21,23 +21,28 @@ internal class VCard private constructor(
         val lastName = lastName.orEmpty()
         val nickname = nickname.orEmpty()
         if (firstName.isNotEmpty() || lastName.isNotEmpty()) {
-            contentBuilder.append("N:$lastName;$firstName;;;\n")
-                .append("FN:${("$firstName $lastName".trim()).ifEmpty { nickname }}\n")
+            contentBuilder.append("N:${lastName.escaped()};${firstName.escaped()};;;\n")
+                .append(
+                    "FN:${("${firstName.escaped()} ${lastName.escaped()}".trim()).ifEmpty { nickname.escaped() }}\n"
+                )
         }
-        val calculatedNickname = nickname.ifEmpty { "$firstName $lastName".trim() }
+        val calculatedNickname = nickname.ifEmpty { "$firstName $lastName".trim() }.escaped()
 
-        calculatedNickname.takeIf { it.isNotEmpty() }?.let { contentBuilder.append("NICKNAME:$it\n") }
-        organization?.takeIf { it.isNotEmpty() }?.let { contentBuilder.append("ORG:$it\n") }
-        title?.takeIf { it.isNotEmpty() }?.let { contentBuilder.append("TITLE:$it\n") }
-        profileUrl?.takeIf { it.isNotEmpty() }?.let { contentBuilder.append("URL:$it\n") }
-        note?.takeIf { it.isNotEmpty() }?.let { contentBuilder.append("NOTE:$it\n") }
-        phoneNumber?.takeIf { it.isNotEmpty() }?.let { contentBuilder.append("TEL;TYPE=cell:$it\n") }
-        email?.takeIf { it.isNotEmpty() }?.let { contentBuilder.append("EMAIL:$it\n") }
+        calculatedNickname.takeIf { it.isNotEmpty() }?.let { contentBuilder.append("NICKNAME:${it.escaped()}\n") }
+        organization?.takeIf { it.isNotEmpty() }?.let { contentBuilder.append("ORG:${it.escaped()}\n") }
+        title?.takeIf { it.isNotEmpty() }?.let { contentBuilder.append("TITLE:${it.escaped()}\n") }
+        profileUrl?.takeIf { it.isNotEmpty() }?.let { contentBuilder.append("URL:${it.escaped()}\n") }
+        note?.takeIf { it.isNotEmpty() }?.let { contentBuilder.append("NOTE:${it.escaped()}\n") }
+        phoneNumber?.takeIf { it.isNotEmpty() }?.let { contentBuilder.append("TEL;TYPE=cell:${it.escaped()}\n") }
+        email?.takeIf { it.isNotEmpty() }?.let { contentBuilder.append("EMAIL:${it.escaped()}\n") }
 
         contentBuilder.append("END:VCARD")
         return contentBuilder.toString()
     }
 
+    // We've seen issues with newlines in the vCard content causing problems when importing the contact so removing them
+    private fun String.escaped() = this.replace("\n", " ")
+
     class Builder(
         private var firstName: String? = null,
         private var lastName: String? = null,

homeUi/src/test/kotlin/com/gravatar/app/homeUi/presentation/home/share/model/VCardTest.kt

@@ -168,4 +168,31 @@ class VCardTest {
             vCardString
         )
     }
+
+    @Test
+    fun `builder replaces newlines with spaces in field values`() {
+        val vCard = VCard.Builder()
+            .firstName("First\nName")
+            .lastName("Last\nName")
+            .nickname("Nick\nName")
+            .organization("Org\nName")
+            .title("Job\nTitle")
+            .profileUrl("http://example.com/profile\nurl")
+            .note("This is a\nnote with\nnewlines.")
+            .phoneNumber("123\n456\n7890")
+            .email("user\nname@example.com")
+            .build()
+
+        val vCardString = vCard.toString()
+
+        assertTrue(vCardString.contains("N:Last Name;First Name;;;"))
+        assertTrue(vCardString.contains("FN:First Name Last Name"))
+        assertTrue(vCardString.contains("NICKNAME:Nick Name"))
+        assertTrue(vCardString.contains("ORG:Org Name"))
+        assertTrue(vCardString.contains("TITLE:Job Title"))
+        assertTrue(vCardString.contains("URL:http://example.com/profile url"))
+        assertTrue(vCardString.contains("NOTE:This is a note with newlines."))
+        assertTrue(vCardString.contains("TEL;TYPE=cell:123 456 7890"))
+        assertTrue(vCardString.contains("EMAIL:user name@example.com"))
+    }
 }