Adds view support for public messages

2025-07-29 15:03:44 -04:00
parent 4cc5aaa49d
commit 35a0b04020
16 changed files with 472 additions and 108 deletions
@@ -33,6 +33,7 @@ import com.vitorpamplona.quartz.experimental.nip95.data.FileStorageEvent
 import com.vitorpamplona.quartz.experimental.nip95.header.FileStorageHeaderEvent
 import com.vitorpamplona.quartz.experimental.nns.NNSEvent
 import com.vitorpamplona.quartz.experimental.profileGallery.ProfileGalleryEntryEvent
+import com.vitorpamplona.quartz.experimental.publicMessages.PublicMessageEvent
 import com.vitorpamplona.quartz.experimental.relationshipStatus.RelationshipStatusEvent
 import com.vitorpamplona.quartz.experimental.zapPolls.PollNoteEvent
 import com.vitorpamplona.quartz.nip01Core.core.Event
@@ -267,6 +268,7 @@ class EventFactory {
                PrivateDmEvent.KIND -> PrivateDmEvent(id, pubKey, createdAt, tags, content, sig)
                PrivateOutboxRelayListEvent.KIND -> PrivateOutboxRelayListEvent(id, pubKey, createdAt, tags, content, sig)
                ProxyRelayListEvent.KIND -> ProxyRelayListEvent(id, pubKey, createdAt, tags, content, sig)
+                PublicMessageEvent.KIND -> PublicMessageEvent(id, pubKey, createdAt, tags, content, sig)
                ReactionEvent.KIND -> ReactionEvent(id, pubKey, createdAt, tags, content, sig)
                RelationshipStatusEvent.KIND -> RelationshipStatusEvent(id, pubKey, createdAt, tags, content, sig)
                RelayAuthEvent.KIND -> RelayAuthEvent(id, pubKey, createdAt, tags, content, sig)
@@ -0,0 +1,96 @@
+/**
+ * Copyright (c) 2025 Vitor Pamplona
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+ * Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
+ * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+package com.vitorpamplona.quartz.experimental.publicMessages
+
+import androidx.compose.runtime.Immutable
+import com.vitorpamplona.quartz.experimental.publicMessages.tags.ReceiverTag
+import com.vitorpamplona.quartz.nip01Core.core.HexKey
+import com.vitorpamplona.quartz.nip01Core.core.TagArrayBuilder
+import com.vitorpamplona.quartz.nip01Core.core.any
+import com.vitorpamplona.quartz.nip01Core.hints.PubKeyHintProvider
+import com.vitorpamplona.quartz.nip01Core.signers.eventTemplate
+import com.vitorpamplona.quartz.nip10Notes.BaseNoteEvent
+import com.vitorpamplona.quartz.nip19Bech32.pubKeyHints
+import com.vitorpamplona.quartz.nip19Bech32.pubKeys
+import com.vitorpamplona.quartz.nip31Alts.alt
+import com.vitorpamplona.quartz.nip50Search.SearchableEvent
+import com.vitorpamplona.quartz.utils.TimeUtils
+
+@Immutable
+class PublicMessageEvent(
+    id: HexKey,
+    pubKey: HexKey,
+    createdAt: Long,
+    tags: Array<Array<String>>,
+    content: String,
+    sig: HexKey,
+) : BaseNoteEvent(id, pubKey, createdAt, KIND, tags, content, sig),
+    PubKeyHintProvider,
+    SearchableEvent {
+    override fun indexableContent() = content
+
+    override fun pubKeyHints() = tags.mapNotNull(ReceiverTag::parseAsHint) + citedNIP19().pubKeyHints()
+
+    override fun linkedPubKeys() = tags.mapNotNull(ReceiverTag::parseKey) + citedNIP19().pubKeys()
+
+    fun isIncluded(pubKey: HexKey) = tags.any(ReceiverTag::match, pubKey) || this.pubKey == pubKey
+
+    fun group() = tags.mapNotNullTo(mutableListOf(ReceiverTag(this.pubKey, null)), ReceiverTag::parse)
+
+    fun groupKeys() = tags.mapNotNullTo(mutableListOf(this.pubKey), ReceiverTag::parseKey)
+
+    fun groupKeySet() = tags.mapNotNullTo(mutableSetOf(this.pubKey), ReceiverTag::parseKey)
+
+    companion object {
+        const val KIND = 24
+        const val ALT_DESCRIPTION = "Public Message"
+
+        fun build(
+            createdAt: Long = TimeUtils.now(),
+            initializer: TagArrayBuilder<PublicMessageEvent>.() -> Unit = {},
+        ) = eventTemplate(KIND, "", createdAt) {
+            alt(ALT_DESCRIPTION)
+            initializer()
+        }
+
+        fun build(
+            to: ReceiverTag,
+            msg: String,
+            createdAt: Long = TimeUtils.now(),
+            initializer: TagArrayBuilder<PublicMessageEvent>.() -> Unit = {},
+        ) = eventTemplate(KIND, msg, createdAt) {
+            alt(ALT_DESCRIPTION)
+            toUser(to)
+            initializer()
+        }
+
+        fun build(
+            to: List<ReceiverTag>,
+            msg: String,
+            createdAt: Long = TimeUtils.now(),
+            initializer: TagArrayBuilder<PublicMessageEvent>.() -> Unit = {},
+        ) = eventTemplate(KIND, msg, createdAt) {
+            alt(ALT_DESCRIPTION)
+            toGroup(to)
+            initializer()
+        }
+    }
+}
@@ -0,0 +1,28 @@
+/**
+ * Copyright (c) 2025 Vitor Pamplona
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+ * Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
+ * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+package com.vitorpamplona.quartz.experimental.publicMessages
+
+import com.vitorpamplona.quartz.experimental.publicMessages.tags.ReceiverTag
+import com.vitorpamplona.quartz.nip01Core.core.TagArrayBuilder
+
+fun TagArrayBuilder<PublicMessageEvent>.toGroup(list: List<ReceiverTag>) = addAll(list.map { it.toTagArray() })
+
+fun TagArrayBuilder<PublicMessageEvent>.toUser(user: ReceiverTag) = add(user.toTagArray())
@@ -0,0 +1,95 @@
+/**
+ * Copyright (c) 2025 Vitor Pamplona
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+ * Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
+ * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+package com.vitorpamplona.quartz.experimental.publicMessages.tags
+
+import com.vitorpamplona.quartz.nip01Core.core.HexKey
+import com.vitorpamplona.quartz.nip01Core.core.Tag
+import com.vitorpamplona.quartz.nip01Core.core.has
+import com.vitorpamplona.quartz.nip01Core.hints.types.PubKeyHint
+import com.vitorpamplona.quartz.nip01Core.relay.normalizer.NormalizedRelayUrl
+import com.vitorpamplona.quartz.nip01Core.relay.normalizer.RelayUrlNormalizer
+import com.vitorpamplona.quartz.nip19Bech32.entities.NProfile
+import com.vitorpamplona.quartz.nip19Bech32.toNpub
+import com.vitorpamplona.quartz.utils.arrayOfNotNull
+import com.vitorpamplona.quartz.utils.ensure
+
+class ReceiverTag(
+    val pubKey: HexKey,
+    val relayHint: NormalizedRelayUrl? = null,
+) {
+    fun toNProfile(): String = NProfile.create(pubKey, relayHint?.let { listOf(it) } ?: emptyList())
+
+    fun toNPub(): String = pubKey.hexToByteArray().toNpub()
+
+    fun toTagArray() = assemble(pubKey, relayHint)
+
+    fun toTagIdOnly() = assemble(pubKey, null)
+
+    companion object Companion {
+        const val TAG_NAME = "p"
+
+        fun isTagged(tag: Array<String>): Boolean = tag.has(1) && tag[0] == TAG_NAME && tag[1].length == 64
+
+        fun match(
+            tag: Array<String>,
+            key: HexKey,
+        ): Boolean = tag.has(1) && tag[0] == TAG_NAME && tag[1] == key
+
+        @JvmStatic
+        fun parse(tag: Tag): ReceiverTag? {
+            ensure(tag.has(1)) { return null }
+            ensure(tag[0] == TAG_NAME) { return null }
+            ensure(tag[1].length == 64) { return null }
+
+            val hint = tag.getOrNull(2)?.let { RelayUrlNormalizer.normalizeOrNull(it) }
+
+            return ReceiverTag(tag[1], hint)
+        }
+
+        @JvmStatic
+        fun parseKey(tag: Tag): HexKey? {
+            ensure(tag.has(1)) { return null }
+            ensure(tag[0] == TAG_NAME) { return null }
+            ensure(tag[1].length == 64) { return null }
+            return tag[1]
+        }
+
+        @JvmStatic
+        fun parseAsHint(tag: Tag): PubKeyHint? {
+            ensure(tag.has(2)) { return null }
+            ensure(tag[0] == TAG_NAME) { return null }
+            ensure(tag[1].length == 64) { return null }
+            ensure(tag[2].isNotEmpty()) { return null }
+
+            val hint = RelayUrlNormalizer.normalizeOrNull(tag[2])
+
+            ensure(hint != null) { return null }
+
+            return PubKeyHint(tag[1], hint)
+        }
+
+        @JvmStatic
+        fun assemble(
+            pubkey: HexKey,
+            relayHint: NormalizedRelayUrl?,
+        ) = arrayOfNotNull(TAG_NAME, pubkey, relayHint?.url)
+    }
+}
@@ -0,0 +1,103 @@
+/**
+ * Copyright (c) 2025 Vitor Pamplona
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+ * Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
+ * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+package com.vitorpamplona.quartz.nip10Notes
+
+import androidx.compose.runtime.Immutable
+import com.vitorpamplona.quartz.nip01Core.core.Event
+import com.vitorpamplona.quartz.nip01Core.core.HexKey
+import com.vitorpamplona.quartz.nip10Notes.content.findIndexTagsWithEventsOrAddresses
+import com.vitorpamplona.quartz.nip10Notes.content.findIndexTagsWithPeople
+import com.vitorpamplona.quartz.nip10Notes.content.findNostrUris
+import com.vitorpamplona.quartz.nip19Bech32.entities.Entity
+import com.vitorpamplona.quartz.nip19Bech32.entities.NAddress
+import com.vitorpamplona.quartz.nip19Bech32.entities.NEmbed
+import com.vitorpamplona.quartz.nip19Bech32.entities.NEvent
+import com.vitorpamplona.quartz.nip19Bech32.entities.NNote
+import com.vitorpamplona.quartz.nip19Bech32.entities.NProfile
+import com.vitorpamplona.quartz.nip19Bech32.entities.NPub
+
+@Immutable
+open class BaseNoteEvent(
+    id: HexKey,
+    pubKey: HexKey,
+    createdAt: Long,
+    kind: Int,
+    tags: Array<Array<String>>,
+    content: String,
+    sig: HexKey,
+) : Event(id, pubKey, createdAt, kind, tags, content, sig) {
+    @Transient
+    private var citedUsersCache: Set<String>? = null
+
+    @Transient
+    private var citedNotesCache: Set<String>? = null
+
+    @Transient
+    private var citedNIP19Cache: List<Entity>? = null
+
+    fun citedNIP19(): List<Entity> {
+        citedNIP19Cache?.let {
+            return it
+        }
+
+        return findNostrUris(content).also { citedNIP19Cache = it }
+    }
+
+    fun citedUsers(): Set<HexKey> {
+        citedUsersCache?.let {
+            return it
+        }
+
+        val citedUsers = mutableSetOf<String>()
+
+        findIndexTagsWithPeople(content, tags, citedUsers)
+        citedNIP19().forEach { parsed ->
+            when (parsed) {
+                is NProfile -> citedUsers.add(parsed.hex)
+                is NPub -> citedUsers.add(parsed.hex)
+            }
+        }
+
+        citedUsersCache = citedUsers
+        return citedUsers
+    }
+
+    fun findCitations(): Set<HexKey> {
+        citedNotesCache?.let {
+            return it
+        }
+
+        val citations = mutableSetOf<String>()
+
+        findIndexTagsWithEventsOrAddresses(content, tags, citations).toMutableSet()
+        citedNIP19().forEach { entity ->
+            when (entity) {
+                is NEvent -> citations.add(entity.hex)
+                is NAddress -> citations.add(entity.aTag())
+                is NNote -> citations.add(entity.hex)
+                is NEmbed -> citations.add(entity.event.id)
+            }
+        }
+
+        citedNotesCache = citations
+        return citations
+    }
+}
@@ -21,21 +21,10 @@
 package com.vitorpamplona.quartz.nip10Notes

 import androidx.compose.runtime.Immutable
-import com.vitorpamplona.quartz.nip01Core.core.Event
 import com.vitorpamplona.quartz.nip01Core.core.HexKey
 import com.vitorpamplona.quartz.nip01Core.tags.addressables.taggedATags
 import com.vitorpamplona.quartz.nip01Core.tags.people.taggedUsers
-import com.vitorpamplona.quartz.nip10Notes.content.findIndexTagsWithEventsOrAddresses
-import com.vitorpamplona.quartz.nip10Notes.content.findIndexTagsWithPeople
-import com.vitorpamplona.quartz.nip10Notes.content.findNostrUris
 import com.vitorpamplona.quartz.nip10Notes.tags.MarkedETag
-import com.vitorpamplona.quartz.nip19Bech32.entities.Entity
-import com.vitorpamplona.quartz.nip19Bech32.entities.NAddress
-import com.vitorpamplona.quartz.nip19Bech32.entities.NEmbed
-import com.vitorpamplona.quartz.nip19Bech32.entities.NEvent
-import com.vitorpamplona.quartz.nip19Bech32.entities.NNote
-import com.vitorpamplona.quartz.nip19Bech32.entities.NProfile
-import com.vitorpamplona.quartz.nip19Bech32.entities.NPub
 import com.vitorpamplona.quartz.nip54Wiki.WikiNoteEvent
 import com.vitorpamplona.quartz.nip72ModCommunities.definition.CommunityDefinitionEvent
 import com.vitorpamplona.quartz.utils.lastNotNullOfOrNull
@@ -49,16 +38,7 @@ open class BaseThreadedEvent(
    tags: Array<Array<String>>,
    content: String,
    sig: HexKey,
-) : Event(id, pubKey, createdAt, kind, tags, content, sig) {
-    @Transient
-    private var citedUsersCache: Set<String>? = null
-
-    @Transient
-    private var citedNotesCache: Set<String>? = null
-
-    @Transient
-    private var citedNIP19Cache: List<Entity>? = null
-
+) : BaseNoteEvent(id, pubKey, createdAt, kind, tags, content, sig) {
    fun mentions() = taggedUsers()

    fun markedRoot() = tags.firstNotNullOfOrNull(MarkedETag::parseRoot)
@@ -92,54 +72,6 @@ open class BaseThreadedEvent(
        return newStyleReply ?: newStyleRoot ?: oldStylePositional
    }

-    fun citedNIP19(): List<Entity> {
-        citedNIP19Cache?.let {
-            return it
-        }
-
-        return findNostrUris(content).also { citedNIP19Cache = it }
-    }
-
-    fun citedUsers(): Set<HexKey> {
-        citedUsersCache?.let {
-            return it
-        }
-
-        val citedUsers = mutableSetOf<String>()
-
-        findIndexTagsWithPeople(content, tags, citedUsers)
-        citedNIP19().forEach { parsed ->
-            when (parsed) {
-                is NProfile -> citedUsers.add(parsed.hex)
-                is NPub -> citedUsers.add(parsed.hex)
-            }
-        }
-
-        citedUsersCache = citedUsers
-        return citedUsers
-    }
-
-    fun findCitations(): Set<HexKey> {
-        citedNotesCache?.let {
-            return it
-        }
-
-        val citations = mutableSetOf<String>()
-
-        findIndexTagsWithEventsOrAddresses(content, tags, citations).toMutableSet()
-        citedNIP19().forEach { entity ->
-            when (entity) {
-                is NEvent -> citations.add(entity.hex)
-                is NAddress -> citations.add(entity.aTag())
-                is NNote -> citations.add(entity.hex)
-                is NEmbed -> citations.add(entity.event.id)
-            }
-        }
-
-        citedNotesCache = citations
-        return citations
-    }
-
    fun tagsWithoutCitations(): List<String> {
        val certainRepliesTo = markedReplyTos()
        val uncertainRepliesTo = unmarkedReplyTos()