Signal-iOS/SignalServiceKit/src/Devices/OWSRecordTranscriptJob.m
2020-02-06 10:26:02 -03:00

371 lines
16 KiB
Objective-C

//
// Copyright (c) 2020 Open Whisper Systems. All rights reserved.
//
#import "OWSRecordTranscriptJob.h"
#import "FunctionalUtil.h"
#import "OWSAttachmentDownloads.h"
#import "OWSDisappearingMessagesJob.h"
#import "OWSIncomingSentMessageTranscript.h"
#import "OWSReadReceiptManager.h"
#import "SSKEnvironment.h"
#import "SSKSessionStore.h"
#import "TSAttachmentPointer.h"
#import "TSGroupThread.h"
#import "TSInfoMessage.h"
#import "TSNetworkManager.h"
#import "TSOutgoingMessage.h"
#import "TSQuotedMessage.h"
#import "TSThread.h"
#import <SignalServiceKit/OWSUnknownProtocolVersionMessage.h>
#import <SignalServiceKit/SignalServiceKit-Swift.h>
NS_ASSUME_NONNULL_BEGIN
@implementation OWSRecordTranscriptJob
#pragma mark - Dependencies
+ (SSKSessionStore *)sessionStore
{
return SSKEnvironment.shared.sessionStore;
}
+ (TSNetworkManager *)networkManager
{
OWSAssertDebug(SSKEnvironment.shared.networkManager);
return SSKEnvironment.shared.networkManager;
}
+ (OWSReadReceiptManager *)readReceiptManager
{
OWSAssert(SSKEnvironment.shared.readReceiptManager);
return SSKEnvironment.shared.readReceiptManager;
}
+ (id<ContactsManagerProtocol>)contactsManager
{
OWSAssertDebug(SSKEnvironment.shared.contactsManager);
return SSKEnvironment.shared.contactsManager;
}
+ (OWSAttachmentDownloads *)attachmentDownloads
{
return SSKEnvironment.shared.attachmentDownloads;
}
+ (SDSDatabaseStorage *)databaseStorage
{
return SDSDatabaseStorage.shared;
}
#pragma mark -
+ (void)processIncomingSentMessageTranscript:(OWSIncomingSentMessageTranscript *)transcript
attachmentHandler:(void (^)(
NSArray<TSAttachmentStream *> *attachmentStreams))attachmentHandler
transaction:(SDSAnyWriteTransaction *)transaction
{
OWSAssertDebug(transcript);
OWSAssertDebug(transaction);
if (transcript.isRecipientUpdate) {
// "Recipient updates" are processed completely separately in order
// to avoid resurrecting threads or messages.
[self processRecipientUpdateWithTranscript:transcript transaction:transaction];
return;
}
OWSLogInfo(@"Recording transcript in thread: %@ timestamp: %llu", transcript.thread.uniqueId, transcript.timestamp);
if (![SDS fitsInInt64:transcript.timestamp]) {
OWSFailDebug(@"Invalid timestamp.");
return;
}
if (transcript.isEndSessionMessage) {
OWSLogInfo(@"EndSession was sent to recipient: %@.", transcript.recipientAddress);
[self.sessionStore deleteAllSessionsForAddress:transcript.recipientAddress transaction:transaction];
// MJK TODO - we don't use this timestamp, safe to remove
TSInfoMessage *infoMessage = [[TSInfoMessage alloc] initWithTimestamp:transcript.timestamp
inThread:transcript.thread
messageType:TSInfoMessageTypeSessionDidEnd];
[infoMessage anyInsertWithTransaction:transaction];
// Don't continue processing lest we print a bubble for the session reset.
return;
}
if (transcript.timestamp < 1) {
OWSFailDebug(@"Transcript is missing timestamp.");
// This transcript is invalid, discard it.
return;
} else if (transcript.dataMessageTimestamp < 1) {
OWSLogError(@"Transcript is missing data message timestamp.");
// Legacy desktop doesn't supply data message timestamp;
// ignore until desktop are in production.
if (SSKFeatureFlags.strictSyncTranscriptTimestamps) {
OWSFailDebug(@"Transcript timestamps do not match, discarding message.");
return;
}
} else if (transcript.timestamp != transcript.dataMessageTimestamp) {
OWSLogVerbose(
@"Transcript timestamps do not match: %llu != %llu", transcript.timestamp, transcript.dataMessageTimestamp);
OWSFailDebug(@"Transcript timestamps do not match, discarding message.");
// This transcript is invalid, discard it.
return;
}
if (transcript.requiredProtocolVersion != nil
&& transcript.requiredProtocolVersion.integerValue > SSKProtos.currentProtocolVersion) {
[self insertUnknownProtocolVersionErrorForTranscript:transcript transaction:transaction];
return;
}
// TODO group updates. Currently desktop doesn't support group updates, so not a problem yet.
TSOutgoingMessageBuilder *messageBuilder = [[TSOutgoingMessageBuilder alloc] initWithThread:transcript.thread
messageBody:transcript.body];
messageBuilder.timestamp = transcript.timestamp;
messageBuilder.expiresInSeconds = transcript.expirationDuration;
messageBuilder.expireStartedAt = transcript.expirationStartedAt;
messageBuilder.quotedMessage = transcript.quotedMessage;
messageBuilder.contactShare = transcript.contact;
messageBuilder.linkPreview = transcript.linkPreview;
messageBuilder.messageSticker = transcript.messageSticker;
messageBuilder.isViewOnceMessage = transcript.isViewOnceMessage;
// We don't need to set:
//
// * isVoiceMessage
// * groupMetaMessage.
// * changeActionsProtoData
// * additionalRecipients.
TSOutgoingMessage *outgoingMessage = [messageBuilder build];
NSArray<TSAttachmentPointer *> *attachmentPointers =
[TSAttachmentPointer attachmentPointersFromProtos:transcript.attachmentPointerProtos
albumMessage:outgoingMessage];
NSMutableArray<NSString *> *attachmentIds = [outgoingMessage.attachmentIds mutableCopy];
for (TSAttachmentPointer *pointer in attachmentPointers) {
[pointer anyInsertWithTransaction:transaction];
[attachmentIds addObject:pointer.uniqueId];
}
outgoingMessage.attachmentIds = [attachmentIds copy];
TSQuotedMessage *_Nullable quotedMessage = transcript.quotedMessage;
if (quotedMessage && quotedMessage.thumbnailAttachmentPointerId) {
// We weren't able to derive a local thumbnail, so we'll fetch the referenced attachment.
TSAttachment *_Nullable attachment =
[TSAttachment anyFetchWithUniqueId:quotedMessage.thumbnailAttachmentPointerId transaction:transaction];
if ([attachment isKindOfClass:[TSAttachmentPointer class]]) {
TSAttachmentPointer *attachmentPointer = (TSAttachmentPointer *)attachment;
OWSLogDebug(@"downloading attachments for transcript: %llu", transcript.timestamp);
[self.attachmentDownloads downloadAttachmentPointer:attachmentPointer
message:outgoingMessage
success:^(NSArray<TSAttachmentStream *> *attachmentStreams) {
OWSAssertDebug(attachmentStreams.count == 1);
TSAttachmentStream *attachmentStream = attachmentStreams.firstObject;
[self.databaseStorage writeWithBlock:^(SDSAnyWriteTransaction *transaction) {
[outgoingMessage
anyUpdateOutgoingMessageWithTransaction:transaction
block:^(TSOutgoingMessage *outgoingMessage) {
[outgoingMessage
setQuotedMessageThumbnailAttachmentStream:
attachmentStream];
}];
}];
}
failure:^(NSError *error) {
OWSLogWarn(
@"failed to fetch thumbnail for transcript: %llu with error: %@", transcript.timestamp, error);
}];
}
}
[[OWSDisappearingMessagesJob sharedJob] becomeConsistentWithDisappearingDuration:outgoingMessage.expiresInSeconds
thread:transcript.thread
createdByRemoteRecipient:nil
createdInExistingGroup:NO
transaction:transaction];
if (transcript.isExpirationTimerUpdate) {
// early return to avoid saving an empty incoming message.
OWSAssertDebug(transcript.body.length == 0);
OWSAssertDebug(outgoingMessage.attachmentIds.count == 0);
return;
}
if (!outgoingMessage.hasRenderableContent && !outgoingMessage.isViewOnceMessage) {
OWSFailDebug(@"Ignoring message transcript for empty message.");
return;
}
[outgoingMessage anyInsertWithTransaction:transaction];
[outgoingMessage updateWithWasSentFromLinkedDeviceWithUDRecipientAddresses:transcript.udRecipientAddresses
nonUdRecipientAddresses:transcript.nonUdRecipientAddresses
isSentUpdate:NO
transaction:transaction];
// The insert and update methods above may start expiration for this message, but
// transcript.expirationStartedAt may be earlier, so we need to pass that to
// the OWSDisappearingMessagesJob in case it needs to back-date the expiration.
[[OWSDisappearingMessagesJob sharedJob] startAnyExpirationForMessage:outgoingMessage
expirationStartedAt:transcript.expirationStartedAt
transaction:transaction];
[self.readReceiptManager applyEarlyReadReceiptsForOutgoingMessageFromLinkedDevice:outgoingMessage
transaction:transaction];
if (outgoingMessage.isViewOnceMessage) {
// To be extra-conservative, always mark
[ViewOnceMessages markAsCompleteWithMessage:outgoingMessage sendSyncMessages:NO transaction:transaction];
} else if (outgoingMessage.hasAttachments) {
// Don't download attachments for "view-once" messages.
[self.attachmentDownloads
downloadAllAttachmentsForMessage:outgoingMessage
transaction:transaction
success:attachmentHandler
failure:^(NSError *error) {
OWSLogError(@"failed to fetch transcripts attachments for message: %@",
outgoingMessage);
}];
}
if (outgoingMessage.messageSticker != nil) {
[StickerManager.shared setHasUsedStickersWithTransaction:transaction];
}
}
+ (void)insertUnknownProtocolVersionErrorForTranscript:(OWSIncomingSentMessageTranscript *)transcript
transaction:(SDSAnyWriteTransaction *)transaction
{
OWSAssertDebug(transcript.thread);
OWSAssertDebug(transaction);
OWSAssertDebug(transcript.requiredProtocolVersion != nil);
OWSFailDebug(@"Unknown protocol version: %@", transcript.requiredProtocolVersion);
if (![SDS fitsInInt64:transcript.timestamp]) {
OWSFailDebug(@"Invalid timestamp.");
return;
}
TSInteraction *message =
[[OWSUnknownProtocolVersionMessage alloc] initWithTimestamp:transcript.timestamp
thread:transcript.thread
sender:nil
protocolVersion:transcript.requiredProtocolVersion.intValue];
[message anyInsertWithTransaction:transaction];
}
#pragma mark -
+ (void)processRecipientUpdateWithTranscript:(OWSIncomingSentMessageTranscript *)transcript
transaction:(SDSAnyWriteTransaction *)transaction
{
OWSAssertDebug(transcript);
OWSAssertDebug(transaction);
if (!SSKFeatureFlags.sendRecipientUpdates) {
OWSFailDebug(@"Ignoring 'recipient update' transcript; disabled.");
return;
}
if (transcript.udRecipientAddresses.count < 1 && transcript.nonUdRecipientAddresses.count < 1) {
OWSFailDebug(@"Ignoring empty 'recipient update' transcript.");
return;
}
uint64_t timestamp = transcript.timestamp;
if (timestamp < 1) {
OWSFailDebug(@"'recipient update' transcript has invalid timestamp.");
return;
}
if (![SDS fitsInInt64:timestamp]) {
OWSFailDebug(@"Invalid timestamp.");
return;
}
if (!transcript.thread.isGroupThread) {
OWSFailDebug(@"'recipient update' has missing or invalid thread.");
return;
}
TSGroupThread *groupThread = (TSGroupThread *)transcript.thread;
NSData *groupId = groupThread.groupModel.groupId;
if (groupId.length < 1) {
OWSFailDebug(@"'recipient update' transcript has invalid groupId.");
return;
}
NSError *error;
NSArray<TSOutgoingMessage *> *messages = (NSArray<TSOutgoingMessage *> *)[InteractionFinder
interactionsWithTimestamp:timestamp
filter:^(TSInteraction *interaction) {
return [interaction isKindOfClass:[TSOutgoingMessage class]];
}
transaction:transaction
error:&error];
if (error != nil) {
OWSFailDebug(@"Error loading interactions: %@", error);
return;
}
if (messages.count < 1) {
// This message may have disappeared.
OWSLogError(@"No matching message with timestamp: %llu.", timestamp);
return;
}
BOOL messageFound = NO;
for (TSOutgoingMessage *message in messages) {
if (!message.isFromLinkedDevice) {
// isFromLinkedDevice isn't always set for very old linked messages, but:
//
// a) We should never receive a "sent update" for a very old message.
// b) It's safe to discard suspicious "sent updates."
continue;
}
TSThread *thread = [message threadWithTransaction:transaction];
if (!thread.isGroupThread) {
continue;
}
TSGroupThread *groupThread = (TSGroupThread *)thread;
if (![groupThread.groupModel.groupId isEqual:groupId]) {
continue;
}
if (!message.isFromLinkedDevice) {
OWSFailDebug(@"Ignoring 'recipient update' for message which was sent locally.");
continue;
}
OWSLogInfo(@"Processing 'recipient update' transcript in thread: %@, timestamp: %llu, nonUdRecipientIds: %d, "
@"udRecipientIds: %d.",
thread.uniqueId,
timestamp,
(int)transcript.nonUdRecipientAddresses.count,
(int)transcript.udRecipientAddresses.count);
[message updateWithWasSentFromLinkedDeviceWithUDRecipientAddresses:transcript.udRecipientAddresses
nonUdRecipientAddresses:transcript.nonUdRecipientAddresses
isSentUpdate:YES
transaction:transaction];
messageFound = YES;
}
if (!messageFound) {
// This message may have disappeared.
OWSLogError(@"No matching message with timestamp: %llu.", timestamp);
}
}
@end
NS_ASSUME_NONNULL_END