feat(core/message_logger): auto purge & message filter

- optimize bridge addMessage
This commit is contained in:
rhunk
2023-12-17 19:09:01 +01:00
parent 607521ec76
commit b925e8f546
8 changed files with 98 additions and 19 deletions

View File

@ -108,6 +108,11 @@ class RemoteSideContext(
streaksReminder.init() streaksReminder.init()
scriptManager.init() scriptManager.init()
messageLogger.init() messageLogger.init()
config.root.messaging.messageLogger.takeIf {
it.globalState == true
}?.getAutoPurgeTime()?.let {
messageLogger.purgeAll(it)
}
}.onFailure { }.onFailure {
log.error("Failed to load RemoteSideContext", it) log.error("Failed to load RemoteSideContext", it)
} }

View File

@ -161,7 +161,7 @@ class SettingsSection(
} }
Button(onClick = { Button(onClick = {
runCatching { runCatching {
context.messageLogger.clearAll() context.messageLogger.purgeAll()
storedMessagesCount = 0 storedMessagesCount = 0
storedStoriesCount = 0 storedStoriesCount = 0
}.onFailure { }.onFailure {

View File

@ -15,12 +15,12 @@ interface MessageLoggerInterface {
/** /**
* Add a message to the message logger database if it is not already there * Add a message to the message logger database if it is not already there
*/ */
boolean addMessage(String conversationId, long id, in byte[] message); oneway void addMessage(String conversationId, long id, in byte[] message);
/** /**
* Delete a message from the message logger database * Delete a message from the message logger database
*/ */
void deleteMessage(String conversationId, long id); oneway void deleteMessage(String conversationId, long id);
/** /**
* Add a story to the message logger database if it is not already there * Add a story to the message logger database if it is not already there

View File

@ -405,7 +405,21 @@
}, },
"message_logger": { "message_logger": {
"name": "Message Logger", "name": "Message Logger",
"description": "Prevents messages from being deleted" "description": "Prevents messages from being deleted",
"properties": {
"keep_my_own_messages": {
"name": "Keep My Own Messages",
"description": "Prevents your own messages from being deleted"
},
"auto_purge": {
"name": "Auto Purge",
"description": "Automatically deletes cached messages that are older than the specified amount of time"
},
"message_filter": {
"name": "Message Filter",
"description": "Select which messages should get logged (empty for all messages)"
}
}
}, },
"auto_save_messages_in_conversations": { "auto_save_messages_in_conversations": {
"name": "Auto Save Messages", "name": "Auto Save Messages",
@ -806,6 +820,20 @@
"edit_text_override": { "edit_text_override": {
"multi_line_chat_input": "Multi Line Chat Input", "multi_line_chat_input": "Multi Line Chat Input",
"bypass_text_input_limit": "Bypass Text Input Limit" "bypass_text_input_limit": "Bypass Text Input Limit"
},
"auto_purge": {
"never": "Never",
"1_hour": "1 Hour",
"3_hours": "3 Hours",
"6_hours": "6 Hours",
"12_hours": "12 Hours",
"1_day": "1 Day",
"3_days": "3 Days",
"1_week": "1 Week",
"2_weeks": "2 Weeks",
"1_month": "1 Month",
"3_months": "3 Months",
"6_months": "6 Months"
} }
} }
}, },

View File

@ -26,12 +26,14 @@ class MessageLoggerWrapper(
SQLiteDatabaseHelper.createTablesFromSchema(openedDatabase, mapOf( SQLiteDatabaseHelper.createTablesFromSchema(openedDatabase, mapOf(
"messages" to listOf( "messages" to listOf(
"id INTEGER PRIMARY KEY", "id INTEGER PRIMARY KEY",
"added_timestamp BIGINT",
"conversation_id VARCHAR", "conversation_id VARCHAR",
"message_id BIGINT", "message_id BIGINT",
"message_data BLOB" "message_data BLOB"
), ),
"stories" to listOf( "stories" to listOf(
"id INTEGER PRIMARY KEY", "id INTEGER PRIMARY KEY",
"added_timestamp BIGINT",
"user_id VARCHAR", "user_id VARCHAR",
"posted_timestamp BIGINT", "posted_timestamp BIGINT",
"created_timestamp BIGINT", "created_timestamp BIGINT",
@ -83,29 +85,33 @@ class MessageLoggerWrapper(
return message return message
} }
override fun addMessage(conversationId: String, messageId: Long, serializedMessage: ByteArray): Boolean { override fun addMessage(conversationId: String, messageId: Long, serializedMessage: ByteArray) {
val cursor = database.rawQuery("SELECT message_id FROM messages WHERE conversation_id = ? AND message_id = ?", arrayOf(conversationId, messageId.toString())) val cursor = database.rawQuery("SELECT message_id FROM messages WHERE conversation_id = ? AND message_id = ?", arrayOf(conversationId, messageId.toString()))
val state = cursor.moveToFirst() val state = cursor.moveToFirst()
cursor.close() cursor.close()
if (state) { if (state) return
return false
}
runBlocking { runBlocking {
withContext(coroutineScope.coroutineContext) { withContext(coroutineScope.coroutineContext) {
database.insert("messages", null, ContentValues().apply { database.insert("messages", null, ContentValues().apply {
put("added_timestamp", System.currentTimeMillis())
put("conversation_id", conversationId) put("conversation_id", conversationId)
put("message_id", messageId) put("message_id", messageId)
put("message_data", serializedMessage) put("message_data", serializedMessage)
}) })
} }
} }
return true
} }
fun clearAll() { fun purgeAll(maxAge: Long? = null) {
coroutineScope.launch { coroutineScope.launch {
database.execSQL("DELETE FROM messages") maxAge?.let {
database.execSQL("DELETE FROM stories") val maxTime = System.currentTimeMillis() - it
database.execSQL("DELETE FROM messages WHERE added_timestamp < ?", arrayOf(maxTime.toString()))
database.execSQL("DELETE FROM stories WHERE added_timestamp < ?", arrayOf(maxTime.toString()))
} ?: run {
database.execSQL("DELETE FROM messages")
database.execSQL("DELETE FROM stories")
}
} }
} }
@ -141,6 +147,7 @@ class MessageLoggerWrapper(
withContext(coroutineScope.coroutineContext) { withContext(coroutineScope.coroutineContext) {
database.insert("stories", null, ContentValues().apply { database.insert("stories", null, ContentValues().apply {
put("user_id", userId) put("user_id", userId)
put("added_timestamp", System.currentTimeMillis())
put("url", url) put("url", url)
put("posted_timestamp", postedAt) put("posted_timestamp", postedAt)
put("created_timestamp", createdAt) put("created_timestamp", createdAt)

View File

@ -15,6 +15,39 @@ class MessagingTweaks : ConfigContainer() {
} }
} }
inner class MessageLoggerConfig : ConfigContainer(hasGlobalState = true) {
val keepMyOwnMessages = boolean("keep_my_own_messages")
private val autoPurge = unique("auto_purge", "1_hour", "3_hours", "6_hours", "12_hours", "1_day", "3_days", "1_week", "2_weeks", "1_month", "3_months", "6_months") {
disabledKey = "features.options.auto_purge.never"
}.apply { set("3_days") }
fun getAutoPurgeTime(): Long? {
return when (autoPurge.getNullable()) {
"1_hour" -> 3600000L
"3_hours" -> 10800000L
"6_hours" -> 21600000L
"12_hours" -> 43200000L
"1_day" -> 86400000L
"3_days" -> 259200000L
"1_week" -> 604800000L
"2_weeks" -> 1209600000L
"1_month" -> 2592000000L
"3_months" -> 7776000000L
"6_months" -> 15552000000L
else -> null
}
}
val messageFilter = multiple("message_filter", "CHAT",
"SNAP",
"NOTE",
"EXTERNAL_MEDIA",
"STICKER"
) {
customOptionTranslationPath = "content_type"
}
}
val bypassScreenshotDetection = boolean("bypass_screenshot_detection") { requireRestart() } val bypassScreenshotDetection = boolean("bypass_screenshot_detection") { requireRestart() }
val anonymousStoryViewing = boolean("anonymous_story_viewing") val anonymousStoryViewing = boolean("anonymous_story_viewing")
val preventStoryRewatchIndicator = boolean("prevent_story_rewatch_indicator") { requireRestart() } val preventStoryRewatchIndicator = boolean("prevent_story_rewatch_indicator") { requireRestart() }
@ -42,7 +75,7 @@ class MessagingTweaks : ConfigContainer() {
val notificationBlacklist = multiple("notification_blacklist", *NotificationType.getIncomingValues().map { it.key }.toTypedArray()) { val notificationBlacklist = multiple("notification_blacklist", *NotificationType.getIncomingValues().map { it.key }.toTypedArray()) {
customOptionTranslationPath = "features.options.notifications" customOptionTranslationPath = "features.options.notifications"
} }
val messageLogger = boolean("message_logger") { addNotices(FeatureNotice.UNSTABLE); requireRestart() } val messageLogger = container("message_logger", MessageLoggerConfig()) { addNotices(FeatureNotice.UNSTABLE); requireRestart() }
val galleryMediaSendOverride = boolean("gallery_media_send_override") { nativeHooks() } val galleryMediaSendOverride = boolean("gallery_media_send_override") { nativeHooks() }
val stripMediaMetadata = multiple("strip_media_metadata", "hide_caption_text", "hide_snap_filters", "hide_extras", "remove_audio_note_duration", "remove_audio_note_transcript_capability") { requireRestart() } val stripMediaMetadata = multiple("strip_media_metadata", "hide_caption_text", "hide_snap_filters", "hide_extras", "remove_audio_note_duration", "remove_audio_note_transcript_capability") { requireRestart() }
val bypassMessageRetentionPolicy = boolean("bypass_message_retention_policy") { addNotices(FeatureNotice.UNSTABLE); requireRestart() } val bypassMessageRetentionPolicy = boolean("bypass_message_retention_policy") { addNotices(FeatureNotice.UNSTABLE); requireRestart() }

View File

@ -34,7 +34,7 @@ class MessageLogger : Feature("MessageLogger",
private val messageLoggerInterface by lazy { context.bridgeClient.getMessageLogger() } private val messageLoggerInterface by lazy { context.bridgeClient.getMessageLogger() }
val isEnabled get() = context.config.messaging.messageLogger.get() val isEnabled get() = context.config.messaging.messageLogger.globalState == true
private val threadPool = Executors.newFixedThreadPool(10) private val threadPool = Executors.newFixedThreadPool(10)
@ -97,18 +97,24 @@ class MessageLogger : Feature("MessageLogger",
} }
override fun init() { override fun init() {
context.event.subscribe(BuildMessageEvent::class, { isEnabled }, priority = 1) { event -> if (!isEnabled) return
val keepMyOwnMessages = context.config.messaging.messageLogger.keepMyOwnMessages.get()
val messageFilter by context.config.messaging.messageLogger.messageFilter
context.event.subscribe(BuildMessageEvent::class, priority = 1) { event ->
val messageInstance = event.message.instanceNonNull() val messageInstance = event.message.instanceNonNull()
if (event.message.messageState != MessageState.COMMITTED) return@subscribe if (event.message.messageState != MessageState.COMMITTED) return@subscribe
cachedIdLinks[event.message.messageDescriptor!!.messageId!!] = event.message.orderKey!! cachedIdLinks[event.message.messageDescriptor!!.messageId!!] = event.message.orderKey!!
val conversationId = event.message.messageDescriptor!!.conversationId.toString() val conversationId = event.message.messageDescriptor!!.conversationId.toString()
//exclude messages sent by me //exclude messages sent by me
if (event.message.senderId.toString() == context.database.myUserId) return@subscribe if (!keepMyOwnMessages && event.message.senderId.toString() == context.database.myUserId) return@subscribe
val uniqueMessageIdentifier = computeMessageIdentifier(conversationId, event.message.orderKey!!) val uniqueMessageIdentifier = computeMessageIdentifier(conversationId, event.message.orderKey!!)
val messageContentType = event.message.messageContent!!.contentType
if (event.message.messageContent!!.contentType != ContentType.STATUS) { if (messageContentType != ContentType.STATUS) {
if (messageFilter.isNotEmpty() && !messageFilter.contains(messageContentType?.name)) return@subscribe
if (fetchedMessages.contains(uniqueMessageIdentifier)) return@subscribe if (fetchedMessages.contains(uniqueMessageIdentifier)) return@subscribe
fetchedMessages.add(uniqueMessageIdentifier) fetchedMessages.add(uniqueMessageIdentifier)

View File

@ -66,7 +66,7 @@ class ChatActionMenu : AbstractMenu() {
override fun init() { override fun init() {
runCatching { runCatching {
if (!context.config.downloader.chatDownloadContextMenu.get() && !context.config.messaging.messageLogger.get() && !context.isDeveloper) return if (!context.config.downloader.chatDownloadContextMenu.get() && context.config.messaging.messageLogger.globalState != true && !context.isDeveloper) return
context.androidContext.classLoader.loadClass("com.snap.messaging.chat.features.actionmenu.ActionMenuChatItemContainer") context.androidContext.classLoader.loadClass("com.snap.messaging.chat.features.actionmenu.ActionMenuChatItemContainer")
.hook("onMeasure", HookStage.BEFORE) { param -> .hook("onMeasure", HookStage.BEFORE) { param ->
param.setArg(1, param.setArg(1,
@ -136,7 +136,7 @@ class ChatActionMenu : AbstractMenu() {
} }
//delete logged message button //delete logged message button
if (context.config.messaging.messageLogger.get()) { if (context.config.messaging.messageLogger.globalState == true) {
injectButton(Button(viewGroup.context).apply { injectButton(Button(viewGroup.context).apply {
text = this@ChatActionMenu.context.translation["chat_action_menu.delete_logged_message_button"] text = this@ChatActionMenu.context.translation["chat_action_menu.delete_logged_message_button"]
setOnClickListener { setOnClickListener {