Parse and render emoji reactions

Fixes part of #152

To keep this PR simple, I've left out:

- when long-pressing on the emoji in a group MMS, a popup should come up listing which contact sent each emoji
- notifications (untested)
- sending emoji reactions
This commit is contained in:
Ben Iofel
2025-08-26 16:17:23 -04:00
parent 394c2f9b3a
commit 401b70d16a
10 changed files with 432 additions and 14 deletions
@@ -36,7 +36,7 @@ class QkRealmMigration @Inject constructor(
) : RealmMigration {
companion object {
const val SchemaVersion: Long = 12
const val SchemaVersion: Long = 13
}
@SuppressLint("ApplySharedPref")
@@ -253,6 +253,28 @@ class QkRealmMigration @Inject constructor(
version++
}
if (version == 12L) {
realm.schema.create("EmojiReaction")
.addField("id", Long::class.java, FieldAttribute.PRIMARY_KEY, FieldAttribute.REQUIRED)
.addField("targetMessageId", Long::class.java, FieldAttribute.INDEXED, FieldAttribute.REQUIRED)
.addField("reactionMessageId", Long::class.java, FieldAttribute.INDEXED, FieldAttribute.REQUIRED)
.addField("senderAddress", String::class.java, FieldAttribute.REQUIRED)
.addField("emoji", String::class.java, FieldAttribute.REQUIRED)
.addField("originalMessageText", String::class.java, FieldAttribute.REQUIRED)
.addField("threadId", Long::class.java, FieldAttribute.INDEXED, FieldAttribute.REQUIRED)
.addField("patternType", String::class.java, FieldAttribute.REQUIRED)
realm.schema.get("Message")
?.addField("isEmojiReaction", Boolean::class.java, FieldAttribute.REQUIRED)
?.transform { msg ->
msg.setBoolean("isEmojiReaction", false)
}
// TODO: scan for past emoji reaction messages
version++
}
check(version >= newVersion) { "Migration missing from v$oldVersion to v$newVersion" }
}
@@ -57,6 +57,7 @@ import dev.octoshrimpy.quik.receiver.SendSmsReceiver
import dev.octoshrimpy.quik.receiver.SmsDeliveredReceiver
import dev.octoshrimpy.quik.receiver.SmsSentReceiver
import dev.octoshrimpy.quik.util.ImageUtils
import dev.octoshrimpy.quik.util.EmojiReactionUtils
import dev.octoshrimpy.quik.util.PhoneNumberUtils
import dev.octoshrimpy.quik.util.Preferences
import dev.octoshrimpy.quik.util.tryOrNull
@@ -88,6 +89,7 @@ open class MessageRepositoryImpl @Inject constructor(
Realm.getDefaultInstance()
.where(Message::class.java)
.equalTo("threadId", threadId)
.equalTo("isEmojiReaction", false)
.let {
when (query.isEmpty()) {
true -> it
@@ -760,6 +762,26 @@ open class MessageRepositoryImpl @Inject constructor(
// Update contentId after the message has been inserted to the content provider
realm.executeTransaction { managedMessage?.contentId = id }
}
managedMessage?.let { savedMessage ->
val parsedReaction = EmojiReactionUtils.parseEmojiReaction(body)
if (parsedReaction != null) {
val targetMessage = EmojiReactionUtils.findTargetMessage(
savedMessage.threadId,
parsedReaction.originalMessage,
realm
)
realm.executeTransaction {
EmojiReactionUtils.saveEmojiReaction(
savedMessage,
parsedReaction,
targetMessage,
messageIds,
realm,
)
}
}
}
}
return message
@@ -42,6 +42,7 @@ import dev.octoshrimpy.quik.model.MmsPart
import dev.octoshrimpy.quik.model.PhoneNumber
import dev.octoshrimpy.quik.model.Recipient
import dev.octoshrimpy.quik.model.SyncLog
import dev.octoshrimpy.quik.util.EmojiReactionUtils
import dev.octoshrimpy.quik.util.PhoneNumberUtils
import dev.octoshrimpy.quik.util.tryOrNull
import io.reactivex.subjects.BehaviorSubject
@@ -104,6 +105,7 @@ class SyncRepositoryImpl @Inject constructor(
realm.delete(Message::class.java)
realm.delete(MmsPart::class.java)
realm.delete(Recipient::class.java)
realm.delete(dev.octoshrimpy.quik.model.EmojiReaction::class.java)
keys.reset()
@@ -202,6 +204,39 @@ class SyncRepositoryImpl @Inject constructor(
syncProgress.onNext(SyncRepository.SyncProgress.Running(0, 0, true))
// Now that we have all the messages, we can scan for emoji reactions
val allMessages = realm.where(Message::class.java)
.beginGroup()
.beginGroup()
.equalTo("type", "sms")
.isNotEmpty("body")
.endGroup()
.or()
.beginGroup()
.equalTo("type", "mms")
.isNotEmpty("parts.text")
.endGroup()
.endGroup()
.findAll()
allMessages.forEach { message ->
val text = message.getText(false)
val parsedReaction = EmojiReactionUtils.parseEmojiReaction(text)
if (parsedReaction != null) {
val targetMessage = EmojiReactionUtils.findTargetMessage(
message.threadId,
parsedReaction.originalMessage,
realm
)
EmojiReactionUtils.saveEmojiReaction(
message,
parsedReaction,
targetMessage,
keys,
realm,
)
}
}
realm.insert(SyncLog())
realm.commitTransaction()
@@ -259,6 +294,27 @@ class SyncRepositoryImpl @Inject constructor(
conversationRepo.getOrCreateConversation(threadId)
insertOrUpdate()
val text = getText(false)
val parsedReaction = EmojiReactionUtils.parseEmojiReaction(text)
if (parsedReaction != null) {
Realm.getDefaultInstance().use { realm ->
val targetMessage = EmojiReactionUtils.findTargetMessage(
threadId,
parsedReaction.originalMessage,
realm
)
realm.executeTransaction {
EmojiReactionUtils.saveEmojiReaction(
this,
parsedReaction,
targetMessage,
keys,
realm,
)
}
}
}
}
}
}
@@ -0,0 +1,134 @@
/*
* Copyright (C) 2025
*
* This file is part of QUIK.
*
* QUIK is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* QUIK is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with QUIK. If not, see <http://www.gnu.org/licenses/>.
*/
package dev.octoshrimpy.quik.util
import dev.octoshrimpy.quik.manager.KeyManager
import dev.octoshrimpy.quik.model.EmojiReaction
import dev.octoshrimpy.quik.model.Message
import io.realm.Realm
import io.realm.Sort
import timber.log.Timber
data class ParsedEmojiReaction(val emoji: String, val originalMessage: String, val patternType: String)
object EmojiReactionUtils {
fun parseEmojiReaction(body: String): ParsedEmojiReaction? {
// Log the raw message with unicode escapes for debugging
val escapedBody = body.map { char ->
when (char.code) {
in 0x20..0x7E -> char.toString() // printable ASCII
else -> "\\u${char.code.toString(16).padStart(4, '0')}"
}
}.joinToString("")
Timber.v("Parsing body: \"$escapedBody\"") // TODO: are we okay logging SMS content?
val iosPattern = Regex("^Reacted (.+?) to \u201C(.+?)\u201D$")
val iosMatch = iosPattern.find(body)
if (iosMatch != null) {
val emoji = iosMatch.groupValues[1]
val originalMessage = iosMatch.groupValues[2]
if (emoji == "with a sticker") {
Timber.d("Skipping sticker reaction: '$originalMessage'")
return null
}
Timber.d("iOS pattern detected - emoji: '$emoji', original: '$originalMessage'")
return ParsedEmojiReaction(emoji, originalMessage, "ios")
}
// https://github.com/octoshrimpy/quik/issues/152#issuecomment-2330183516
val googleMessagesPattern = Regex("^\u200A\u200B(.+?)\u200B to \u201C\u200A(.+?)\u200A\u201D\u200A$")
val googleMatch = googleMessagesPattern.find(body)
if (googleMatch != null) {
val emoji = googleMatch.groupValues[1]
val originalMessage = googleMatch.groupValues[2]
Timber.d("Google Messages pattern detected - emoji: '$emoji', original: '$originalMessage'")
return ParsedEmojiReaction(emoji, originalMessage, "google")
}
return null
}
/**
* Search for messages in the same thread with matching text content
* We'll search recent messages first (within reasonable time window)
*/
fun findTargetMessage(threadId: Long, originalMessageText: String, realm: Realm): Message? {
val messages = realm.where(Message::class.java)
.equalTo("threadId", threadId)
.sort("date", Sort.DESCENDING)
.limit(50) // TODO: should we keep this limit?
.findAll()
val exactMatch = messages.find { message ->
message.getText(false).trim() == originalMessageText.trim()
}
if (exactMatch != null) {
Timber.d("Found exact match for reaction target: message ID ${exactMatch.id}")
return exactMatch
}
// Try partial match (in case of truncation)
val partialMatch = messages.find { message ->
val text = message.getText(false).trim()
text.isNotEmpty() && (
text.contains(originalMessageText.trim(), ignoreCase = true) ||
originalMessageText.trim().contains(text, ignoreCase = true)
)
}
if (partialMatch != null) {
Timber.d("Found partial match for reaction target: message ID ${partialMatch.id}")
return partialMatch
}
Timber.w("No target message found for reaction text: '$originalMessageText'")
return null
}
fun saveEmojiReaction(
reactionMessage: Message,
parsedReaction: ParsedEmojiReaction,
targetMessage: Message?,
keyManager: KeyManager,
realm: Realm,
) {
val reaction = EmojiReaction().apply {
id = keyManager.newId()
reactionMessageId = reactionMessage.id
targetMessageId = targetMessage?.id ?: 0
senderAddress = reactionMessage.address
emoji = parsedReaction.emoji
originalMessageText = parsedReaction.originalMessage
threadId = reactionMessage.threadId
patternType = parsedReaction.patternType
}
realm.insertOrUpdate(reaction)
reactionMessage.isEmojiReaction = true
realm.insertOrUpdate(reactionMessage)
if (targetMessage != null) {
Timber.i("Saved emoji reaction: ${reaction.emoji} from ${reaction.senderAddress} to message ${targetMessage.id}")
} else {
Timber.w("Saved emoji reaction without target message: ${reaction.emoji} from ${reaction.senderAddress}")
}
}
}