991 lines
39 KiB
Swift
991 lines
39 KiB
Swift
//
|
|
// Copyright 2019 Signal Messenger, LLC
|
|
// SPDX-License-Identifier: AGPL-3.0-only
|
|
//
|
|
|
|
import Foundation
|
|
public import LibSignalClient
|
|
|
|
public extension TSMessage {
|
|
|
|
@objc
|
|
var isIncoming: Bool { self is TSIncomingMessage }
|
|
|
|
@objc
|
|
var isOutgoing: Bool { self is TSOutgoingMessage }
|
|
|
|
// MARK: - Attachments
|
|
|
|
func hasBodyAttachments(transaction: DBReadTransaction) -> Bool {
|
|
guard let sqliteRowId else { return false }
|
|
return !DependenciesBridge.shared.attachmentStore
|
|
.fetchReferences(
|
|
owners: [
|
|
.messageOversizeText(messageRowId: sqliteRowId),
|
|
.messageBodyAttachment(messageRowId: sqliteRowId),
|
|
],
|
|
tx: transaction,
|
|
)
|
|
.isEmpty
|
|
}
|
|
|
|
func hasMediaAttachments(transaction: DBReadTransaction) -> Bool {
|
|
guard let sqliteRowId else { return false }
|
|
return DependenciesBridge.shared.attachmentStore
|
|
.fetchAnyReference(
|
|
owner: .messageBodyAttachment(messageRowId: sqliteRowId),
|
|
tx: transaction,
|
|
) != nil
|
|
}
|
|
|
|
func oversizeTextAttachment(transaction: DBReadTransaction) -> Attachment? {
|
|
guard let sqliteRowId else { return nil }
|
|
return DependenciesBridge.shared.attachmentStore
|
|
.fetchAnyReferencedAttachment(
|
|
for: .messageOversizeText(messageRowId: sqliteRowId),
|
|
tx: transaction,
|
|
)?
|
|
.attachment
|
|
}
|
|
|
|
private func allAttachments(transaction tx: DBReadTransaction) -> [ReferencedAttachment] {
|
|
guard let sqliteRowId else { return [] }
|
|
return DependenciesBridge.shared.attachmentStore.fetchReferencedAttachmentsOwnedByMessage(
|
|
messageRowId: sqliteRowId,
|
|
tx: tx,
|
|
)
|
|
}
|
|
|
|
/// The raw body contains placeholders for things like mentions and is not user friendly.
|
|
/// If you want a constant string representing the body of this message, this is it.
|
|
@objc(rawBodyWithTransaction:)
|
|
func rawBody(transaction: DBReadTransaction) -> String? {
|
|
if let oversizeText = try? self.oversizeTextAttachment(transaction: transaction)?.asStream()?.decryptedLongText() {
|
|
return oversizeText
|
|
}
|
|
return self.body?.nilIfEmpty
|
|
}
|
|
|
|
func skippedAttachmentIds(tx: DBReadTransaction) -> Set<Attachment.IDType> {
|
|
var result = Set<Attachment.IDType>()
|
|
for attachment in allAttachments(transaction: tx).map(\.attachment) {
|
|
guard
|
|
attachment.asStream() == nil,
|
|
let attachmentPointer = attachment.asAnyPointer()
|
|
else {
|
|
continue
|
|
}
|
|
switch attachmentPointer.downloadState(tx: tx) {
|
|
case .enqueuedOrDownloading:
|
|
continue
|
|
case .failed, .none:
|
|
result.insert(attachmentPointer.id)
|
|
}
|
|
}
|
|
return result
|
|
}
|
|
|
|
// MARK: Attachment Deletes
|
|
|
|
@objc
|
|
func removeAllAttachments(tx: DBWriteTransaction) {
|
|
let attachmentStore = DependenciesBridge.shared.attachmentStore
|
|
for referencedAttachment in allAttachments(transaction: tx) {
|
|
attachmentStore.removeReference(
|
|
reference: referencedAttachment.reference,
|
|
tx: tx,
|
|
)
|
|
}
|
|
}
|
|
|
|
// MARK: - Pinned Message Deletes
|
|
|
|
@objc
|
|
func unpinMessageIfNeeded(tx: DBWriteTransaction) {
|
|
let pinnedMessageManager = DependenciesBridge.shared.pinnedMessageManager
|
|
pinnedMessageManager.deletePinForMessage(interactionId: sqliteRowId!, transaction: tx)
|
|
}
|
|
|
|
// MARK: - Mentions
|
|
|
|
@objc
|
|
func insertMentionsInDatabase(tx: DBWriteTransaction) {
|
|
Self.insertMentionsInDatabase(message: self, tx: tx)
|
|
}
|
|
|
|
static func insertMentionsInDatabase(message: TSMessage, tx: DBWriteTransaction) {
|
|
guard let bodyRanges = message.bodyRanges else {
|
|
return
|
|
}
|
|
// If we have any mentions, we need to save them to aid in querying for
|
|
// messages that mention a given user. We only need to save one mention
|
|
// record per ACI, even if the same ACI is mentioned multiple times in the
|
|
// message.
|
|
let uniqueMentionedAcis = Set(bodyRanges.mentions.values)
|
|
for mentionedAci in uniqueMentionedAcis {
|
|
let mention = TSMention(uniqueMessageId: message.uniqueId, uniqueThreadId: message.uniqueThreadId, aci: mentionedAci)
|
|
mention.anyInsert(transaction: tx)
|
|
}
|
|
}
|
|
|
|
// MARK: - Reactions
|
|
|
|
var reactionFinder: ReactionFinder {
|
|
return ReactionFinder(uniqueMessageId: uniqueId)
|
|
}
|
|
|
|
@objc
|
|
func removeAllReactions(transaction: DBWriteTransaction) {
|
|
guard !CurrentAppContext().isRunningTests else { return }
|
|
reactionFinder.deleteAllReactions(transaction: transaction)
|
|
}
|
|
|
|
@objc
|
|
func removeAllMentions(transaction tx: DBWriteTransaction) {
|
|
MentionFinder.deleteAllMentions(for: self, transaction: tx)
|
|
}
|
|
|
|
@objc
|
|
func allReactionIds(transaction: DBReadTransaction) -> [String]? {
|
|
return reactionFinder.allUniqueIds(transaction: transaction)
|
|
}
|
|
|
|
@objc
|
|
func markUnreadReactionsAsRead(transaction: DBWriteTransaction) {
|
|
let unreadReactions = reactionFinder.unreadReactions(transaction: transaction)
|
|
unreadReactions.forEach { $0.markAsRead(transaction: transaction) }
|
|
}
|
|
|
|
func reaction(for reactor: Aci, tx: DBReadTransaction) -> OWSReaction? {
|
|
return reactionFinder.reaction(for: reactor, tx: tx)
|
|
}
|
|
|
|
@discardableResult
|
|
func recordReaction(
|
|
for reactor: Aci,
|
|
emoji: String,
|
|
sentAtTimestamp: UInt64,
|
|
receivedAtTimestamp: UInt64,
|
|
tx: DBWriteTransaction,
|
|
) -> (oldValue: OWSReaction?, newValue: OWSReaction)? {
|
|
return self.recordReaction(
|
|
for: reactor,
|
|
emoji: emoji,
|
|
sentAtTimestamp: sentAtTimestamp,
|
|
sortOrder: receivedAtTimestamp,
|
|
tx: tx,
|
|
)
|
|
}
|
|
|
|
@discardableResult
|
|
func recordReaction(
|
|
for reactor: Aci,
|
|
emoji: String,
|
|
sentAtTimestamp: UInt64,
|
|
sortOrder: UInt64,
|
|
tx: DBWriteTransaction,
|
|
) -> (oldValue: OWSReaction?, newValue: OWSReaction)? {
|
|
guard !wasRemotelyDeleted else {
|
|
owsFailDebug("attempted to record a reaction for a message that was deleted")
|
|
return nil
|
|
}
|
|
|
|
assert(emoji.isSingleEmoji)
|
|
|
|
// Remove any previous reaction, there can only be one
|
|
let oldReaction = removeReaction(for: reactor, tx: tx)
|
|
|
|
let newReaction = OWSReaction(
|
|
uniqueMessageId: uniqueId,
|
|
emoji: emoji,
|
|
reactorAci: reactor,
|
|
reactorPhoneNumber: nil,
|
|
sentAtTimestamp: sentAtTimestamp,
|
|
sortOrder: receivedAtTimestamp,
|
|
)
|
|
|
|
newReaction.anyInsert(transaction: tx)
|
|
|
|
// Reactions to messages we send need to be manually marked
|
|
// as read as they trigger notifications we need to clear
|
|
// out. Everything else can be automatically read.
|
|
if !(self is TSOutgoingMessage) { newReaction.markAsRead(transaction: tx) }
|
|
|
|
SSKEnvironment.shared.databaseStorageRef.touch(interaction: self, shouldReindex: false, tx: tx)
|
|
|
|
return (oldReaction, newReaction)
|
|
}
|
|
|
|
@discardableResult
|
|
func removeReaction(for reactor: Aci, tx: DBWriteTransaction) -> OWSReaction? {
|
|
guard let reaction = reaction(for: reactor, tx: tx) else {
|
|
return nil
|
|
}
|
|
|
|
reaction.anyRemove(transaction: tx)
|
|
SSKEnvironment.shared.databaseStorageRef.touch(interaction: self, shouldReindex: false, tx: tx)
|
|
|
|
SSKEnvironment.shared.notificationPresenterRef.cancelNotifications(reactionId: reaction.uniqueId)
|
|
|
|
return reaction
|
|
}
|
|
|
|
// MARK: - Edits
|
|
|
|
func removeEdits(transaction: DBWriteTransaction) {
|
|
processRelatedMessageEdits(
|
|
deleteEditRecords: true,
|
|
tx: transaction,
|
|
processMessage: { message in
|
|
// Don't delete the message driving the deletion, just the related edits/interactions.
|
|
// The presumption is the message itself will be deleted after this step.
|
|
guard message.uniqueId != self.uniqueId else { return }
|
|
|
|
// Delete the message, but since edits are already in the process of being
|
|
// handled, don't do anything further by passing in `.doNotDelete`
|
|
DependenciesBridge.shared.interactionDeleteManager.delete(
|
|
message,
|
|
sideEffects: .custom(deleteAssociatedEdits: false),
|
|
tx: transaction,
|
|
)
|
|
},
|
|
)
|
|
}
|
|
|
|
/// Enumerate "edited messages" (ie revisions) related to self.
|
|
///
|
|
/// You may pass the latest revision or a prior revision. Prior revisions
|
|
/// are passed to `processMessage` before the latest revision. If there
|
|
/// aren't any prior revisions, `self` is assumed to be the latest revision.
|
|
///
|
|
/// The message for `self` isn't re-fetched -- `self` is always passed to
|
|
/// `processMessage`. (Note also that `self` is always passed to
|
|
/// `processMessage` exactly once.)
|
|
///
|
|
/// The processing of edit records is unbounded, but the number of edits per
|
|
/// message is limited by both the sender and receiver.
|
|
private func processRelatedMessageEdits(
|
|
deleteEditRecords: Bool,
|
|
tx: DBWriteTransaction,
|
|
processMessage: (TSMessage) -> Void,
|
|
) {
|
|
let editMessageStore = DependenciesBridge.shared.editMessageStore
|
|
let editRecords = editMessageStore.findEditRecords(relatedTo: self, tx: tx)
|
|
|
|
if deleteEditRecords {
|
|
for editRecord in editRecords {
|
|
failIfThrows {
|
|
try editRecord.delete(tx.database)
|
|
}
|
|
}
|
|
}
|
|
|
|
let pastRevisionIds = Set(editRecords.map(\.pastRevisionId))
|
|
var latestRevisionIds = Set(editRecords.map(\.latestRevisionId))
|
|
latestRevisionIds.subtract(pastRevisionIds)
|
|
|
|
if editRecords.isEmpty {
|
|
latestRevisionIds.insert(self.sqliteRowId!)
|
|
} else {
|
|
// Check the integrity of the EditRecords.
|
|
if latestRevisionIds.count != 1 || pastRevisionIds.count != editRecords.count {
|
|
let revisionIds = editRecords.map { ($0.pastRevisionId, $0.latestRevisionId) }
|
|
owsFailDebug("Found malformed edit history: \(revisionIds)")
|
|
}
|
|
}
|
|
|
|
for revisionId in pastRevisionIds.sorted() + latestRevisionIds.sorted() {
|
|
if revisionId == self.sqliteRowId {
|
|
processMessage(self)
|
|
} else {
|
|
let interaction = InteractionFinder.fetch(rowId: revisionId, transaction: tx)
|
|
if let message = interaction as? TSMessage {
|
|
processMessage(message)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// MARK: - Remote Delete
|
|
|
|
// A message can be remotely deleted iff:
|
|
// * you sent this message
|
|
// * you haven't already remotely deleted this message
|
|
// * it's not a message with a gift badge
|
|
// * it has been less than 24 hours since you sent the message
|
|
// * this includes messages sent in the future
|
|
var canBeRemotelyDeletedByNonAdmin: Bool {
|
|
guard let outgoingMessage = self as? TSOutgoingMessage else { return false }
|
|
guard !outgoingMessage.wasRemotelyDeleted else { return false }
|
|
guard outgoingMessage.giftBadge == nil else { return false }
|
|
|
|
let (elapsedTime, isInFuture) = Date.ows_millisecondTimestamp().subtractingReportingOverflow(outgoingMessage.timestamp)
|
|
|
|
let normalDeleteLimit = RemoteConfig.current.normalDeleteMaxAgeInSeconds * TimeInterval(MSEC_PER_SEC)
|
|
guard isInFuture || (TimeInterval(elapsedTime) <= normalDeleteLimit) else { return false }
|
|
|
|
return true
|
|
}
|
|
|
|
var canBeRemotelyDeletedByAdmin: Bool {
|
|
guard isIncoming || isOutgoing else { return false }
|
|
|
|
var timestampOfMessage: UInt64 = self.timestamp
|
|
|
|
if let incomingMessage = self as? TSIncomingMessage {
|
|
if let serverTimestamp = incomingMessage.serverTimestamp {
|
|
timestampOfMessage = serverTimestamp.uint64Value
|
|
}
|
|
guard !incomingMessage.wasRemotelyDeleted else { return false }
|
|
}
|
|
|
|
if let outgoingMessage = self as? TSOutgoingMessage {
|
|
guard !outgoingMessage.wasRemotelyDeleted else { return false }
|
|
}
|
|
|
|
let (elapsedTime, isInFuture) = Date.ows_millisecondTimestamp().subtractingReportingOverflow(timestampOfMessage)
|
|
|
|
let adminDeleteLimit = RemoteConfig.current.adminDeleteMaxAgeInSeconds * TimeInterval(MSEC_PER_SEC)
|
|
guard isInFuture || (TimeInterval(elapsedTime) <= adminDeleteLimit) else { return false }
|
|
|
|
return true
|
|
}
|
|
|
|
enum RemoteDeleteError: Int, Error {
|
|
case deletedMessageMissing
|
|
case invalidDelete
|
|
}
|
|
|
|
static func remotelyDeleteMessage(
|
|
_ message: TSMessage,
|
|
deleteAuthorAci: Aci,
|
|
allowedDeleteTimeframeSeconds: TimeInterval,
|
|
serverTimestamp: UInt64,
|
|
transaction: DBWriteTransaction,
|
|
) throws(RemoteDeleteError) -> TSMessage {
|
|
guard message.isIncoming || message.isOutgoing else {
|
|
owsFailDebug("Message to delete is not incoming or outgoing")
|
|
throw .invalidDelete
|
|
}
|
|
|
|
guard let localAci = DependenciesBridge.shared.tsAccountManager.localIdentifiers(tx: transaction)?.aci else {
|
|
throw .invalidDelete
|
|
}
|
|
|
|
var latestMessage = message
|
|
if message.editState == .pastRevision {
|
|
// The remote delete targeted an old revision, fetch
|
|
// swap out the target message for the latest (or return an error)
|
|
// This avoids cases where older edits could be deleted and
|
|
// leave newer revisions
|
|
if
|
|
let latestEdit = DependenciesBridge.shared.editMessageStore.findMessage(
|
|
fromEdit: message,
|
|
tx: transaction,
|
|
)
|
|
{
|
|
latestMessage = latestEdit
|
|
} else {
|
|
Logger.info("Ignoring delete for missing edit target.")
|
|
throw .invalidDelete
|
|
}
|
|
}
|
|
|
|
// Client has already validated timestamp if local user is deleting a message.
|
|
if deleteAuthorAci == localAci {
|
|
latestMessage.markMessageAsRemotelyDeleted(transaction: transaction)
|
|
return latestMessage
|
|
}
|
|
|
|
let deleteThreshold = TimeInterval(allowedDeleteTimeframeSeconds)
|
|
|
|
if latestMessage.isOutgoing {
|
|
let serverDate = Date(millisecondsSince1970: serverTimestamp)
|
|
let messageDate = Date(millisecondsSince1970: latestMessage.timestamp)
|
|
|
|
guard messageDate.addingTimeInterval(deleteThreshold) > serverDate else {
|
|
owsFailDebug("Ignoring outgoing message delete sent more than allowed threshold after the original message")
|
|
throw .invalidDelete
|
|
}
|
|
|
|
latestMessage.markMessageAsRemotelyDeleted(transaction: transaction)
|
|
return latestMessage
|
|
} else if let incoming = latestMessage as? TSIncomingMessage {
|
|
guard let messageToDeleteServerTimestamp = incoming.serverTimestamp else {
|
|
// Older messages might be missing this, but since we only allow deleting for a small
|
|
// window after you send a message we should generally never hit this path.
|
|
owsFailDebug("can't delete a message without a serverTimestamp")
|
|
throw .invalidDelete
|
|
}
|
|
|
|
let serverDate = Date(millisecondsSince1970: serverTimestamp)
|
|
let messageDate = Date(millisecondsSince1970: messageToDeleteServerTimestamp.uint64Value)
|
|
|
|
guard messageDate.addingTimeInterval(deleteThreshold) > serverDate else {
|
|
owsFailDebug("Ignoring incoming message delete sent more than allowed threshold after the original message")
|
|
throw .invalidDelete
|
|
}
|
|
|
|
latestMessage.markMessageAsRemotelyDeleted(transaction: transaction)
|
|
return latestMessage
|
|
}
|
|
|
|
owsFailDebug("Message not incoming or outgoing")
|
|
throw .invalidDelete
|
|
}
|
|
|
|
class func tryToRemotelyDeleteMessageAsNonAdmin(
|
|
fromAuthor authorAci: Aci,
|
|
sentAtTimestamp: UInt64,
|
|
threadUniqueId: String?,
|
|
serverTimestamp: UInt64,
|
|
transaction: DBWriteTransaction,
|
|
) throws(RemoteDeleteError) {
|
|
guard SDS.fitsInInt64(sentAtTimestamp) else {
|
|
owsFailDebug("Unable to delete a message with invalid sentAtTimestamp: \(sentAtTimestamp)")
|
|
throw .invalidDelete
|
|
}
|
|
|
|
if
|
|
let threadUniqueId, let messageToDelete = InteractionFinder.findMessage(
|
|
withTimestamp: sentAtTimestamp,
|
|
threadId: threadUniqueId,
|
|
author: SignalServiceAddress(authorAci),
|
|
transaction: transaction,
|
|
)
|
|
{
|
|
let allowDeleteTimeframe = RemoteConfig.current.normalDeleteMaxAgeInSeconds + .day
|
|
let _ = try remotelyDeleteMessage(
|
|
messageToDelete,
|
|
deleteAuthorAci: authorAci,
|
|
allowedDeleteTimeframeSeconds: allowDeleteTimeframe,
|
|
serverTimestamp: serverTimestamp,
|
|
transaction: transaction,
|
|
)
|
|
|
|
} else if
|
|
let storyMessage = StoryFinder.story(
|
|
timestamp: sentAtTimestamp,
|
|
author: authorAci,
|
|
transaction: transaction,
|
|
)
|
|
{
|
|
// If there are still valid contexts for this outgoing private story message, don't actually delete the model.
|
|
if
|
|
storyMessage.groupId == nil,
|
|
case .outgoing(let recipientStates) = storyMessage.manifest,
|
|
!recipientStates.values.flatMap({ $0.contexts }).isEmpty
|
|
{
|
|
return
|
|
}
|
|
|
|
storyMessage.anyRemove(transaction: transaction)
|
|
} else {
|
|
// The message doesn't exist locally, so nothing to do.
|
|
Logger.info("Attempted to remotely delete a message that doesn't exist \(sentAtTimestamp)")
|
|
throw .deletedMessageMissing
|
|
}
|
|
|
|
}
|
|
|
|
private func markMessageAsRemotelyDeleted(transaction: DBWriteTransaction) {
|
|
// Delete any past edit revisions.
|
|
processRelatedMessageEdits(
|
|
deleteEditRecords: false,
|
|
tx: transaction,
|
|
processMessage: { message in
|
|
message.updateWithRemotelyDeletedAndRemoveRenderableContent(with: transaction)
|
|
},
|
|
)
|
|
SSKEnvironment.shared.notificationPresenterRef.cancelNotifications(messageIds: [self.uniqueId])
|
|
}
|
|
|
|
// MARK: - Preview text
|
|
|
|
@objc(previewTextForGiftBadgeWithTransaction:)
|
|
func previewTextForGiftBadge(transaction: DBReadTransaction) -> String {
|
|
if let incomingMessage = self as? TSIncomingMessage {
|
|
let senderShortName = SSKEnvironment.shared.contactManagerRef.displayName(
|
|
for: incomingMessage.authorAddress,
|
|
tx: transaction,
|
|
).resolvedValue(useShortNameIfAvailable: true)
|
|
let format = OWSLocalizedString(
|
|
"DONATION_ON_BEHALF_OF_A_FRIEND_PREVIEW_INCOMING",
|
|
comment: "A friend has donated on your behalf. This text is shown in the list of chats, when the most recent message is one of these donations. Embeds {friend's short display name}.",
|
|
)
|
|
return String.nonPluralLocalizedStringWithFormat(format, senderShortName)
|
|
} else if let outgoingMessage = self as? TSOutgoingMessage {
|
|
let recipientShortName: String
|
|
let recipients = outgoingMessage.recipientAddresses()
|
|
if let recipient = recipients.first, recipients.count == 1 {
|
|
recipientShortName = SSKEnvironment.shared.contactManagerRef.displayName(
|
|
for: recipient,
|
|
tx: transaction,
|
|
).resolvedValue(useShortNameIfAvailable: true)
|
|
} else {
|
|
owsFailDebug("[Gifting] Expected exactly 1 recipient but got \(recipients.count)")
|
|
recipientShortName = CommonStrings.unknownUser
|
|
}
|
|
let format = OWSLocalizedString(
|
|
"DONATION_ON_BEHALF_OF_A_FRIEND_PREVIEW_OUTGOING",
|
|
comment: "You have a made a donation on a friend's behalf. This text is shown in the list of chats, when the most recent message is one of these donations. Embeds {friend's short display name}.",
|
|
)
|
|
return String.nonPluralLocalizedStringWithFormat(format, recipientShortName)
|
|
} else {
|
|
owsFail("Could not generate preview text because message wasn't incoming or outgoing")
|
|
}
|
|
}
|
|
|
|
func notificationPreviewText(_ tx: DBReadTransaction) -> String {
|
|
switch previewText(tx) {
|
|
case let .body(body, prefix, ranges):
|
|
let hydrated = MessageBody(text: body, ranges: ranges ?? .empty)
|
|
.hydrating(mentionHydrator: ContactsMentionHydrator.mentionHydrator(transaction: tx))
|
|
.asPlaintext()
|
|
guard let prefix else {
|
|
return hydrated.filterForDisplay
|
|
}
|
|
return prefix.appending(hydrated).filterForDisplay
|
|
case let .remotelyDeleted(text),
|
|
let .storyReactionEmoji(text),
|
|
let .viewOnceMessage(text),
|
|
let .contactShare(text),
|
|
let .stickerDescription(text),
|
|
let .giftBadge(text),
|
|
let .infoMessage(text),
|
|
let .paymentMessage(text):
|
|
return text
|
|
case .empty:
|
|
return ""
|
|
}
|
|
}
|
|
|
|
func conversationListPreviewText(_ tx: DBReadTransaction) -> HydratedMessageBody {
|
|
switch previewText(tx) {
|
|
case let .body(body, prefix, ranges):
|
|
let hydrated = MessageBody(text: body, ranges: ranges ?? .empty)
|
|
.hydrating(mentionHydrator: ContactsMentionHydrator.mentionHydrator(transaction: tx))
|
|
guard let prefix else {
|
|
return hydrated
|
|
}
|
|
return hydrated.addingPrefix(prefix)
|
|
case let .remotelyDeleted(text),
|
|
let .storyReactionEmoji(text),
|
|
let .viewOnceMessage(text),
|
|
let .contactShare(text),
|
|
let .stickerDescription(text),
|
|
let .giftBadge(text),
|
|
let .infoMessage(text),
|
|
let .paymentMessage(text):
|
|
return HydratedMessageBody.fromPlaintextWithoutRanges(text)
|
|
case .empty:
|
|
return HydratedMessageBody.fromPlaintextWithoutRanges("")
|
|
}
|
|
}
|
|
|
|
func conversationListSearchResultsBody(_ tx: DBReadTransaction) -> MessageBody? {
|
|
switch previewText(tx) {
|
|
case let .body(body, _, ranges):
|
|
// We ignore the prefix here.
|
|
return MessageBody(text: body, ranges: ranges ?? .empty)
|
|
case .remotelyDeleted,
|
|
.storyReactionEmoji,
|
|
.viewOnceMessage,
|
|
.contactShare,
|
|
.stickerDescription,
|
|
.giftBadge,
|
|
.infoMessage,
|
|
.paymentMessage,
|
|
.empty:
|
|
return nil
|
|
}
|
|
}
|
|
|
|
private enum PreviewText {
|
|
case body(String, prefix: String?, ranges: MessageBodyRanges?)
|
|
case remotelyDeleted(String)
|
|
case storyReactionEmoji(String)
|
|
case viewOnceMessage(String)
|
|
case contactShare(String)
|
|
case stickerDescription(String)
|
|
case giftBadge(String)
|
|
case infoMessage(String)
|
|
case paymentMessage(String)
|
|
case empty
|
|
}
|
|
|
|
private func previewText(_ tx: DBReadTransaction) -> PreviewText {
|
|
let tsAccountManager = DependenciesBridge.shared.tsAccountManager
|
|
|
|
if let infoMessage = self as? TSInfoMessage {
|
|
return .infoMessage(infoMessage.infoMessagePreviewText(with: tx))
|
|
}
|
|
|
|
if self is OWSPaymentMessage || self is OWSArchivedPaymentMessage {
|
|
return .paymentMessage(OWSLocalizedString(
|
|
"PAYMENTS_THREAD_PREVIEW_TEXT",
|
|
comment: "Payments Preview Text shown in chat list for payments.",
|
|
))
|
|
}
|
|
|
|
if self.wasRemotelyDeleted {
|
|
guard let localAci = tsAccountManager.localIdentifiers(tx: tx)?.aci else {
|
|
owsFailDebug("Local user not registered when trying to find delete author")
|
|
return .remotelyDeleted(OWSLocalizedString("THIS_MESSAGE_WAS_DELETED", comment: "text indicating the message was remotely deleted"))
|
|
}
|
|
|
|
let remoteDeleteString: String
|
|
let deleteAuthor = displayNameForDeleteMessage(localAci: localAci, transaction: tx)
|
|
switch deleteAuthor {
|
|
case .admin(_, let displayName):
|
|
let format = OWSLocalizedString("DELETED_BY_ADMIN", comment: "Text indicating the message was remotely deleted by an admin. Embeds {{admin display name}}")
|
|
remoteDeleteString = String.nonPluralLocalizedStringWithFormat(format, displayName)
|
|
case .regular(let displayName):
|
|
let format = OWSLocalizedString(
|
|
"DELETED_THIS_MESSAGE",
|
|
comment: "Text indicating the message was remotely deleted by its author. Embeds {{ author name }}",
|
|
)
|
|
remoteDeleteString = String.nonPluralLocalizedStringWithFormat(format, displayName)
|
|
case .localUser:
|
|
remoteDeleteString = OWSLocalizedString("YOU_DELETED_THIS_MESSAGE", comment: "text indicating the message was remotely deleted by you")
|
|
}
|
|
return .remotelyDeleted(remoteDeleteString)
|
|
}
|
|
|
|
let bodyDescription = self.rawBody(transaction: tx)
|
|
if
|
|
bodyDescription == nil,
|
|
let storyReactionEmoji = storyReactionEmoji?.strippedOrNil,
|
|
let storyAuthorAci = storyAuthorAci?.wrappedAciValue
|
|
{
|
|
let contactManager = SSKEnvironment.shared.contactManagerRef
|
|
|
|
if
|
|
let localIdentifiers = tsAccountManager.localIdentifiers(tx: tx),
|
|
localIdentifiers.contains(serviceId: storyAuthorAci)
|
|
{
|
|
return .storyReactionEmoji(String.nonPluralLocalizedStringWithFormat(
|
|
OWSLocalizedString(
|
|
"STORY_REACTION_PREVIEW_FORMAT_THIRD_PERSON_REACTS_TO_SECOND_PERSON",
|
|
comment: "Text explaining that someone reacted to your story. Embeds {{ %1$@ reaction emoji }}.",
|
|
),
|
|
storyReactionEmoji,
|
|
))
|
|
} else if isOutgoing {
|
|
// Local user is the one who reacted to someone else's story.
|
|
let storyAuthorName = contactManager.displayName(for: SignalServiceAddress(storyAuthorAci), tx: tx)
|
|
return .storyReactionEmoji(String.nonPluralLocalizedStringWithFormat(
|
|
OWSLocalizedString(
|
|
"STORY_REACTION_PREVIEW_FORMAT_SECOND_PERSON",
|
|
comment: "Text explaining that you reacted to someone else's story. Embeds {{ %1$@ reaction emoji, %2$@ story author name }}.",
|
|
),
|
|
storyReactionEmoji,
|
|
storyAuthorName.resolvedValue(useShortNameIfAvailable: true),
|
|
))
|
|
} else if
|
|
let incomingMessage = self as? TSIncomingMessage,
|
|
let reactionAuthorAci = incomingMessage.authorAddress.aci
|
|
{
|
|
// Non-local user reacted to someone else's story.
|
|
let storyAuthorName = contactManager.displayName(for: SignalServiceAddress(storyAuthorAci), tx: tx)
|
|
let reactionAuthorName = contactManager.displayName(for: SignalServiceAddress(reactionAuthorAci), tx: tx)
|
|
return .storyReactionEmoji(String.nonPluralLocalizedStringWithFormat(
|
|
OWSLocalizedString(
|
|
"STORY_REACTION_PREVIEW_FORMAT_THIRD_PERSON_REACTS_TO_THIRD_PERSON",
|
|
comment: "Text explaining that someone reacted to another person's story. Embeds {{ %1$@ reaction author's name, %2$@ reaction emoji, %3$@ story author name }}.",
|
|
),
|
|
reactionAuthorName.resolvedValue(useShortNameIfAvailable: true),
|
|
storyReactionEmoji,
|
|
storyAuthorName.resolvedValue(useShortNameIfAvailable: true),
|
|
))
|
|
} else {
|
|
owsFailDebug("Invalid story reaction state")
|
|
return .empty
|
|
}
|
|
}
|
|
|
|
let mediaAttachment: ReferencedAttachment?
|
|
if
|
|
let sqliteRowId,
|
|
let attachment = DependenciesBridge.shared.attachmentStore
|
|
.fetchAnyReferencedAttachment(for: .messageBodyAttachment(messageRowId: sqliteRowId), tx: tx)
|
|
{
|
|
mediaAttachment = attachment
|
|
} else {
|
|
mediaAttachment = nil
|
|
}
|
|
let attachmentEmoji = mediaAttachment?.previewEmoji()
|
|
let attachmentDescription = mediaAttachment?.previewText()
|
|
|
|
if isViewOnceMessage {
|
|
if self is TSOutgoingMessage || mediaAttachment == nil {
|
|
return .viewOnceMessage(OWSLocalizedString(
|
|
"PER_MESSAGE_EXPIRATION_NOT_VIEWABLE",
|
|
comment: "inbox cell and notification text for an already viewed view-once media message.",
|
|
))
|
|
} else if
|
|
let mimeType = mediaAttachment?.attachment.mimeType,
|
|
MimeTypeUtil.isSupportedVideoMimeType(mimeType)
|
|
{
|
|
return .viewOnceMessage(OWSLocalizedString(
|
|
"PER_MESSAGE_EXPIRATION_VIDEO_PREVIEW",
|
|
comment: "inbox cell and notification text for a view-once video.",
|
|
))
|
|
} else {
|
|
// Make sure that if we add new types we cover them here.
|
|
return .viewOnceMessage(OWSLocalizedString(
|
|
"PER_MESSAGE_EXPIRATION_PHOTO_PREVIEW",
|
|
comment: "inbox cell and notification text for a view-once photo.",
|
|
))
|
|
}
|
|
}
|
|
|
|
var pollPrefix: String?
|
|
if isPoll {
|
|
let locPollString = OWSLocalizedString(
|
|
"POLL_PREFIX",
|
|
comment: "Prefix for a poll preview",
|
|
)
|
|
|
|
pollPrefix = PollMessageManager.pollEmoji + locPollString + " "
|
|
}
|
|
|
|
if let bodyDescription = bodyDescription?.nilIfEmpty {
|
|
let prefix = pollPrefix ?? attachmentEmoji?.nilIfEmpty?.appending(" ")
|
|
return .body(bodyDescription, prefix: prefix, ranges: bodyRanges)
|
|
} else if let attachmentDescription = attachmentDescription?.nilIfEmpty {
|
|
return .body(attachmentDescription, prefix: nil, ranges: bodyRanges)
|
|
} else if let contactShare {
|
|
return .contactShare("👤".appending(" ").appending(contactShare.name.displayName))
|
|
} else if let messageSticker {
|
|
let stickerDescription = OWSLocalizedString(
|
|
"STICKER_MESSAGE_PREVIEW",
|
|
comment: "Preview text shown in notifications and conversation list for sticker messages.",
|
|
)
|
|
if let stickerEmoji = StickerManager.firstEmoji(in: messageSticker.emoji ?? "")?.nilIfEmpty {
|
|
return .stickerDescription(stickerEmoji.appending(" ").appending(stickerDescription))
|
|
} else {
|
|
return .stickerDescription(stickerDescription)
|
|
}
|
|
} else if giftBadge != nil {
|
|
return .giftBadge(self.previewTextForGiftBadge(transaction: tx))
|
|
} else {
|
|
// This can happen when initially saving outgoing messages
|
|
// with camera first capture over the conversation list.
|
|
return .empty
|
|
}
|
|
}
|
|
|
|
// MARK: - Stories
|
|
|
|
@objc
|
|
enum ReplyCountIncrement: Int {
|
|
case noIncrement
|
|
case newReplyAdded
|
|
case replyDeleted
|
|
}
|
|
|
|
@objc
|
|
func touchStoryMessageIfNecessary(
|
|
replyCountIncrement: ReplyCountIncrement,
|
|
transaction: DBWriteTransaction,
|
|
) {
|
|
guard
|
|
self.isStoryReply,
|
|
let storyAuthorAci,
|
|
let storyTimestamp
|
|
else {
|
|
return
|
|
}
|
|
let storyMessage = StoryFinder.story(
|
|
timestamp: storyTimestamp.uint64Value,
|
|
author: storyAuthorAci.wrappedAciValue,
|
|
transaction: transaction,
|
|
)
|
|
if let storyMessage {
|
|
// Note that changes are aggregated; the touch below won't double
|
|
// up observer notifications.
|
|
SSKEnvironment.shared.databaseStorageRef.touch(storyMessage: storyMessage, tx: transaction)
|
|
switch replyCountIncrement {
|
|
case .noIncrement:
|
|
break
|
|
case .newReplyAdded:
|
|
storyMessage.incrementReplyCount(transaction)
|
|
case .replyDeleted:
|
|
storyMessage.decrementReplyCount(transaction)
|
|
}
|
|
}
|
|
}
|
|
|
|
// MARK: - Indexing
|
|
|
|
@objc
|
|
internal func _anyDidInsert(tx: DBWriteTransaction) {
|
|
FullTextSearchIndexer.insert(self, tx: tx)
|
|
}
|
|
|
|
@objc
|
|
internal func _anyDidUpdate(tx: DBWriteTransaction) {
|
|
FullTextSearchIndexer.update(self, tx: tx)
|
|
}
|
|
}
|
|
|
|
// MARK: - Renderable content
|
|
|
|
extension TSMessage {
|
|
|
|
/// Unsafe to use before insertion; until attachments are inserted (which happens after message insertion)
|
|
/// this may not return accurate results.
|
|
public func insertedMessageHasRenderableContent(
|
|
rowId: Int64,
|
|
tx: DBReadTransaction,
|
|
) -> Bool {
|
|
var fetchedAttachments: [AttachmentReference]?
|
|
func fetchAttachments() -> [AttachmentReference] {
|
|
if let fetchedAttachments { return fetchedAttachments }
|
|
guard let sqliteRowId else { return [] }
|
|
let attachments = DependenciesBridge.shared.attachmentStore.fetchReferences(
|
|
owners: [
|
|
.messageOversizeText(messageRowId: sqliteRowId),
|
|
.messageBodyAttachment(messageRowId: sqliteRowId),
|
|
],
|
|
tx: tx,
|
|
)
|
|
fetchedAttachments = attachments
|
|
return attachments
|
|
}
|
|
|
|
var isPaymentMessage = false
|
|
if self is OWSPaymentMessage {
|
|
isPaymentMessage = true
|
|
}
|
|
|
|
return TSMessageBuilder.hasRenderableContent(
|
|
hasNonemptyBody: body?.nilIfEmpty != nil,
|
|
hasBodyAttachmentsOrOversizeText: !fetchAttachments().isEmpty,
|
|
hasLinkPreview: linkPreview != nil,
|
|
hasQuotedReply: quotedMessage != nil,
|
|
hasContactShare: contactShare != nil,
|
|
hasSticker: messageSticker != nil,
|
|
hasGiftBadge: giftBadge != nil,
|
|
isStoryReply: isStoryReply,
|
|
isPaymentMessage: isPaymentMessage,
|
|
storyReactionEmoji: storyReactionEmoji,
|
|
isPoll: isPoll,
|
|
)
|
|
}
|
|
|
|
// MARK: - Remote Delete String
|
|
|
|
public func displayNameForDeleteMessage(localAci: Aci, transaction: DBReadTransaction) -> RemoteDeleteAuthor {
|
|
let adminDeleteManager = DependenciesBridge.shared.adminDeleteManager
|
|
|
|
let adminAuthorAci = adminDeleteManager.adminDeleteAuthor(
|
|
interactionId: self.sqliteRowId!,
|
|
tx: transaction,
|
|
)
|
|
|
|
if let adminAuthorAci {
|
|
if adminAuthorAci == localAci {
|
|
// Display usual self delete message for outgoing self-deletion.
|
|
return .localUser
|
|
} else if let incomingMessage = self as? TSIncomingMessage, incomingMessage.authorAddress.aci == adminAuthorAci {
|
|
// Display usual (non-admin) other user delete for incoming self-deletion.
|
|
let displayName = SSKEnvironment.shared.contactManagerRef.displayName(
|
|
for: SignalServiceAddress(adminAuthorAci),
|
|
tx: transaction,
|
|
).resolvedValue(useShortNameIfAvailable: true)
|
|
return .regular(displayName: displayName)
|
|
} else {
|
|
// Only display admin name if non self-delete.
|
|
let displayName = SSKEnvironment.shared.contactManagerRef.displayName(
|
|
for: SignalServiceAddress(adminAuthorAci),
|
|
tx: transaction,
|
|
).resolvedValue()
|
|
return .admin(aci: adminAuthorAci, displayName: displayName)
|
|
}
|
|
}
|
|
|
|
// Non-admin outgoing message must be deleted by local user.
|
|
guard let incomingMessage = self as? TSIncomingMessage else {
|
|
return .localUser
|
|
}
|
|
|
|
// Non-admin incoming message must be deleted by its author.
|
|
let displayName = SSKEnvironment.shared.contactManagerRef.displayName(
|
|
for: incomingMessage.authorAddress,
|
|
tx: transaction,
|
|
).resolvedValue(useShortNameIfAvailable: true)
|
|
|
|
return .regular(displayName: displayName)
|
|
}
|
|
}
|
|
|
|
extension TSMessageBuilder {
|
|
|
|
public func hasRenderableContent(
|
|
hasBodyAttachments: Bool,
|
|
hasLinkPreview: Bool,
|
|
hasQuotedReply: Bool,
|
|
hasContactShare: Bool,
|
|
hasSticker: Bool,
|
|
hasPayment: Bool,
|
|
hasPoll: Bool,
|
|
) -> Bool {
|
|
return Self.hasRenderableContent(
|
|
hasNonemptyBody: messageBody?.nilIfEmpty != nil,
|
|
hasBodyAttachmentsOrOversizeText: hasBodyAttachments,
|
|
hasLinkPreview: hasLinkPreview,
|
|
hasQuotedReply: hasQuotedReply,
|
|
hasContactShare: hasContactShare,
|
|
hasSticker: hasSticker,
|
|
hasGiftBadge: giftBadge != nil,
|
|
isStoryReply: storyAuthorAci != nil && storyTimestamp != nil,
|
|
isPaymentMessage: hasPayment,
|
|
storyReactionEmoji: storyReactionEmoji,
|
|
isPoll: hasPoll,
|
|
)
|
|
}
|
|
|
|
public static func hasRenderableContent(
|
|
hasNonemptyBody: Bool,
|
|
hasBodyAttachmentsOrOversizeText: @autoclosure () -> Bool,
|
|
hasLinkPreview: Bool,
|
|
hasQuotedReply: Bool,
|
|
hasContactShare: Bool,
|
|
hasSticker: Bool,
|
|
hasGiftBadge: Bool,
|
|
isStoryReply: Bool,
|
|
isPaymentMessage: Bool,
|
|
storyReactionEmoji: String?,
|
|
isPoll: Bool,
|
|
) -> Bool {
|
|
if isPaymentMessage {
|
|
// Android doesn't include any body or other content in payments.
|
|
return true
|
|
}
|
|
|
|
// Story replies currently only support a subset of message features, so may not
|
|
// be renderable in some circumstances where a normal message would be.
|
|
if isStoryReply {
|
|
return hasNonemptyBody || (storyReactionEmoji?.isSingleEmoji ?? false)
|
|
}
|
|
|
|
// We DO NOT consider a message with just a linkPreview
|
|
// or quotedMessage to be renderable.
|
|
if hasNonemptyBody || hasContactShare || hasSticker || hasGiftBadge {
|
|
return true
|
|
}
|
|
|
|
if hasBodyAttachmentsOrOversizeText() {
|
|
return true
|
|
}
|
|
|
|
if isPoll {
|
|
return true
|
|
}
|
|
|
|
return false
|
|
}
|
|
}
|