Files
damus/damus/Features/Posting/Models/Post.swift
T
alltheseas ec28822451 Add Damus client tag emission
- Add ClientTagMetadata struct with parsing helpers and documentation
- Append Damus client tags when posting across app, share, and drafts flows
- Gate the behavior behind a new publish_client_tag setting (default on)

Changelog-Added: Add client tag to published events to identify Damus
Ref: https://github.com/damus-io/damus/issues/3323
Signed-off-by: alltheseas <alltheseas@users.noreply.github.com>
2026-02-27 13:19:55 -08:00

158 lines
5.0 KiB
Swift

//
// Post.swift
// damus
//
// Created by William Casarin on 2022-05-07.
//
import Foundation
struct NostrPost {
let kind: NostrKind
let content: String
let tags: [[String]]
init(content: String, kind: NostrKind = .text, tags: [[String]] = []) {
self.content = content
self.kind = kind
self.tags = tags
}
func to_event(keypair: FullKeypair, clientTag: [String]? = nil) -> NostrEvent? {
let post_blocks = self.parse_blocks()
let post_tags = self.make_post_tags(post_blocks: post_blocks, tags: self.tags)
let content = post_tags.blocks
.map(\.asString)
.joined(separator: "")
if self.kind == .highlight {
var new_tags = post_tags.tags.filter({ $0[safe: 0] != "comment" })
if content.count > 0 {
new_tags.append(["comment", content])
}
addClientTagIfNeeded(clientTag, to: &new_tags)
return NostrEvent(content: self.content, keypair: keypair.to_keypair(), kind: self.kind.rawValue, tags: new_tags)
}
var final_tags = post_tags.tags
addClientTagIfNeeded(clientTag, to: &final_tags)
return NostrEvent(content: content, keypair: keypair.to_keypair(), kind: self.kind.rawValue, tags: final_tags)
}
func parse_blocks() -> [Block] {
guard let content_for_parsing = self.default_content_for_block_parsing() else { return [] }
return parse_post_blocks(content: content_for_parsing)?.blocks ?? []
}
private func default_content_for_block_parsing() -> String? {
switch kind {
case .highlight:
return tags.filter({ $0[safe: 0] == "comment" }).first?[safe: 1]
default:
return self.content
}
}
/// Parse the post's contents to find more tags to apply to the final nostr event
func make_post_tags(post_blocks: [Block], tags: [[String]]) -> PostTags {
var new_tags = tags
for post_block in post_blocks {
switch post_block {
case .mention(let mention):
switch(mention.ref.nip19) {
case .note, .nevent:
continue
default:
break
}
new_tags.append(mention.ref.tag)
case .hashtag(let hashtag):
new_tags.append(["t", hashtag.lowercased()])
case .text: break
case .invoice: break
case .relay: break
case .url(let url):
new_tags.append(["r", url.absoluteString])
break
}
}
return PostTags(blocks: post_blocks, tags: new_tags)
}
}
extension NostrPost {
/// Appends a client tag to the tags array if one is provided and not already present.
fileprivate func addClientTagIfNeeded(_ clientTag: [String]?, to tags: inout [[String]]) {
guard let clientTag else { return }
guard tags.first(where: { $0.first == "client" }) == nil else {
return
}
tags.append(clientTag)
}
}
// MARK: - Helper structures and functions
extension NostrPost {
/// A struct used for temporarily holding tag information that was parsed from a post contents to aid in building a nostr event
struct PostTags {
let blocks: [Block]
let tags: [[String]]
}
}
/// This should only be used in tests, we don't use this anymore directly
func parse_note_content(content: NoteContent) -> Blocks?
{
switch content {
case .note(let note):
return parse_post_blocks(content: note.content)
case .content(let content, _):
return parse_post_blocks(content: content)
}
}
/// Return a list of tags
func parse_post_blocks(content: String) -> Blocks? {
let buf_size = 16000
var buffer = Data(capacity: buf_size)
var blocks_ptr = ndb_blocks_ptr()
var ok = false
return content.withCString { c_content -> Blocks? in
buffer.withUnsafeMutableBytes { buf in
let res = ndb_parse_content(buf, Int32(buf_size), c_content, Int32(content.utf8.count), &blocks_ptr.ptr)
ok = res != 0
}
guard ok else { return nil }
let words = ndb_blocks_word_count(blocks_ptr.ptr)
let bs = collect_blocks(ptr: blocks_ptr, content: c_content)
return Blocks(words: Int(words), blocks: bs)
}
}
fileprivate func collect_blocks(ptr: ndb_blocks_ptr, content: UnsafePointer<CChar>) -> [Block] {
var i = ndb_block_iterator()
var blocks: [Block] = []
var block_ptr = ndb_block_ptr()
ndb_blocks_iterate_start(content, ptr.ptr, &i);
block_ptr.ptr = ndb_blocks_iterate_next(&i)
while (block_ptr.ptr != nil) {
// tags are only used for indexed mentions which aren't used in
// posts anymore, so to simplify the API let's set this to nil
if let block = Block(block: block_ptr, tags: nil) {
blocks.append(block);
}
block_ptr.ptr = ndb_blocks_iterate_next(&i)
}
return blocks
}