Path: blob/main/SignalServiceKit/Messages/Interactions/PinnedMessages/OutgoingUnpinMessage.swift
1 views
//
// Copyright 2025 Signal Messenger, LLC
// SPDX-License-Identifier: AGPL-3.0-only
//
import Foundation
public import LibSignalClient
public class OutgoingUnpinMessage: TransientOutgoingMessage {
override public class var supportsSecureCoding: Bool { true }
public required init?(coder: NSCoder) {
guard
let targetMessageAuthorAciBinary = coder.decodeObject(of: NSData.self, forKey: "targetMessageAuthorAciBinary") as Data?,
let targetMessageAuthorAci = try? Aci.parseFrom(serviceIdBinary: targetMessageAuthorAciBinary)
else {
return nil
}
self.targetMessageAuthorAci = targetMessageAuthorAci
guard let targetMessageTimestamp = coder.decodeObject(of: NSNumber.self, forKey: "targetMessageTimestamp") else {
return nil
}
self.targetMessageTimestamp = targetMessageTimestamp.uint64Value
super.init(coder: coder)
}
override public func encode(with coder: NSCoder) {
super.encode(with: coder)
coder.encode(targetMessageAuthorAci.serviceIdBinary, forKey: "targetMessageAuthorAciBinary")
coder.encode(NSNumber(value: self.targetMessageTimestamp), forKey: "targetMessageTimestamp")
}
override public var hash: Int {
var hasher = Hasher()
hasher.combine(super.hash)
hasher.combine(targetMessageAuthorAci)
hasher.combine(targetMessageTimestamp)
return hasher.finalize()
}
override public func isEqual(_ object: Any?) -> Bool {
guard let object = object as? Self else { return false }
guard super.isEqual(object) else { return false }
guard self.targetMessageAuthorAci == object.targetMessageAuthorAci else { return false }
guard self.targetMessageTimestamp == object.targetMessageTimestamp else { return false }
return true
}
public let targetMessageTimestamp: UInt64
public let targetMessageAuthorAci: Aci
public init(
thread: TSThread,
targetMessageTimestamp: UInt64,
targetMessageAuthorAci: Aci,
messageExpiresInSeconds: UInt32,
tx: DBReadTransaction,
) {
self.targetMessageTimestamp = targetMessageTimestamp
self.targetMessageAuthorAci = targetMessageAuthorAci
let builder: TSOutgoingMessageBuilder = .withDefaultValues(
thread: thread,
expiresInSeconds: messageExpiresInSeconds,
)
super.init(
outgoingMessageWith: builder,
additionalRecipients: [],
explicitRecipients: [],
skippedRecipients: [],
transaction: tx,
)
}
override var contentHint: SealedSenderContentHint { .implicit }
override public func dataMessageBuilder(
with thread: TSThread,
transaction: DBReadTransaction,
) -> SSKProtoDataMessageBuilder? {
guard
let localAci = DependenciesBridge.shared.tsAccountManager.localIdentifiers(tx: transaction)?.aci,
thread.canUserEditPinnedMessages(aci: localAci, tx: transaction)
else {
Logger.error("Local user no longer has permission to change pin status")
return nil
}
guard
let dataMessageBuilder = super.dataMessageBuilder(
with: thread,
transaction: transaction,
)
else {
return nil
}
let unpinMessageBuilder = SSKProtoDataMessageUnpinMessage.builder()
unpinMessageBuilder.setTargetSentTimestamp(targetMessageTimestamp)
unpinMessageBuilder.setTargetAuthorAciBinary(targetMessageAuthorAci.serviceIdBinary)
dataMessageBuilder.setUnpinMessage(
unpinMessageBuilder.buildInfallibly(),
)
return dataMessageBuilder
}
override public func updateWithSendSuccess(tx: DBWriteTransaction) {
let pinnedMessageManager = DependenciesBridge.shared.pinnedMessageManager
pinnedMessageManager.applyPinMessageChangeToLocalState(
targetTimestamp: targetMessageTimestamp,
targetAuthorAci: targetMessageAuthorAci,
expiresAt: nil,
isPin: false,
sentTimestamp: timestamp,
threadUniqueId: threadUniqueId,
tx: tx,
)
}
}