5679 lines
162 KiB
TypeScript
5679 lines
162 KiB
TypeScript
// Copyright 2020 Signal Messenger, LLC
|
|
// SPDX-License-Identifier: AGPL-3.0-only
|
|
|
|
import { compact, has, isNumber, throttle, debounce } from 'lodash';
|
|
import { batch as batchDispatch } from 'react-redux';
|
|
import { v4 as generateGuid } from 'uuid';
|
|
import PQueue from 'p-queue';
|
|
|
|
import type { ReadonlyDeep } from 'type-fest';
|
|
import type {
|
|
ConversationAttributesType,
|
|
ConversationLastProfileType,
|
|
ConversationRenderInfoType,
|
|
MessageAttributesType,
|
|
QuotedMessageType,
|
|
SenderKeyInfoType,
|
|
} from '../model-types.d';
|
|
import { getConversation } from '../util/getConversation';
|
|
import { drop } from '../util/drop';
|
|
import { isShallowEqual } from '../util/isShallowEqual';
|
|
import { getInitials } from '../util/getInitials';
|
|
import { clearTimeoutIfNecessary } from '../util/clearTimeoutIfNecessary';
|
|
import { getMessageSentTimestamp } from '../util/getMessageSentTimestamp';
|
|
import type { AttachmentType, ThumbnailType } from '../types/Attachment';
|
|
import { toDayMillis } from '../util/timestamp';
|
|
import { areWeAdmin } from '../util/areWeAdmin';
|
|
import { isBlocked } from '../util/isBlocked';
|
|
import { getAboutText } from '../util/getAboutText';
|
|
import { getAvatarPath } from '../util/avatarUtils';
|
|
import { getDraftPreview } from '../util/getDraftPreview';
|
|
import { hasDraft } from '../util/hasDraft';
|
|
import * as Conversation from '../types/Conversation';
|
|
import type { StickerType, StickerWithHydratedData } from '../types/Stickers';
|
|
import * as Stickers from '../types/Stickers';
|
|
import { StorySendMode } from '../types/Stories';
|
|
import type { EmbeddedContactWithHydratedAvatar } from '../types/EmbeddedContact';
|
|
import type { GroupV2InfoType } from '../textsecure/SendMessage';
|
|
import createTaskWithTimeout from '../textsecure/TaskWithTimeout';
|
|
import MessageSender from '../textsecure/SendMessage';
|
|
import type {
|
|
CallbackResultType,
|
|
PniSignatureMessageType,
|
|
} from '../textsecure/Types.d';
|
|
import type {
|
|
ConversationType,
|
|
DraftPreviewType,
|
|
} from '../state/ducks/conversations';
|
|
import type {
|
|
AvatarColorType,
|
|
ConversationColorType,
|
|
CustomColorType,
|
|
} from '../types/Colors';
|
|
import type { MessageModel } from './messages';
|
|
import { getAuthor } from '../messages/helpers';
|
|
import { strictAssert } from '../util/assert';
|
|
import { isConversationMuted } from '../util/isConversationMuted';
|
|
import { isConversationSMSOnly } from '../util/isConversationSMSOnly';
|
|
import {
|
|
isConversationEverUnregistered,
|
|
isConversationUnregistered,
|
|
isConversationUnregisteredAndStale,
|
|
} from '../util/isConversationUnregistered';
|
|
import { sniffImageMimeType } from '../util/sniffImageMimeType';
|
|
import { isValidE164 } from '../util/isValidE164';
|
|
import type { MIMEType } from '../types/MIME';
|
|
import { IMAGE_JPEG, IMAGE_WEBP } from '../types/MIME';
|
|
import type { AciString, PniString, ServiceIdString } from '../types/ServiceId';
|
|
import {
|
|
ServiceIdKind,
|
|
normalizeServiceId,
|
|
normalizePni,
|
|
} from '../types/ServiceId';
|
|
import { isAciString } from '../util/isAciString';
|
|
import {
|
|
constantTimeEqual,
|
|
decryptProfile,
|
|
decryptProfileName,
|
|
deriveAccessKey,
|
|
} from '../Crypto';
|
|
import * as Bytes from '../Bytes';
|
|
import type { DraftBodyRanges } from '../types/BodyRange';
|
|
import { BodyRange } from '../types/BodyRange';
|
|
import { migrateColor } from '../util/migrateColor';
|
|
import { isNotNil } from '../util/isNotNil';
|
|
import {
|
|
NotificationType,
|
|
notificationService,
|
|
} from '../services/notifications';
|
|
import { storageServiceUploadJob } from '../services/storage';
|
|
import { getSendOptions } from '../util/getSendOptions';
|
|
import type { IsConversationAcceptedOptionsType } from '../util/isConversationAccepted';
|
|
import { isConversationAccepted } from '../util/isConversationAccepted';
|
|
import {
|
|
getNumber,
|
|
getProfileName,
|
|
getTitle,
|
|
getTitleNoDefault,
|
|
hasNumberTitle,
|
|
hasUsernameTitle,
|
|
canHaveUsername,
|
|
} from '../util/getTitle';
|
|
import { markConversationRead } from '../util/markConversationRead';
|
|
import { handleMessageSend } from '../util/handleMessageSend';
|
|
import { getConversationMembers } from '../util/getConversationMembers';
|
|
import { updateConversationsWithUuidLookup } from '../updateConversationsWithUuidLookup';
|
|
import { ReadStatus } from '../messages/MessageReadStatus';
|
|
import { SendStatus } from '../messages/MessageSendState';
|
|
import type {
|
|
LinkPreviewType,
|
|
LinkPreviewWithHydratedData,
|
|
} from '../types/message/LinkPreviews';
|
|
import { MINUTE, SECOND, DurationInSeconds } from '../util/durations';
|
|
import { concat, filter, map, repeat, zipObject } from '../util/iterables';
|
|
import * as universalExpireTimer from '../util/universalExpireTimer';
|
|
import type { GroupNameCollisionsWithIdsByTitle } from '../util/groupMemberNameCollisions';
|
|
import {
|
|
isDirectConversation,
|
|
isGroup,
|
|
isGroupV1,
|
|
isGroupV2,
|
|
isMe,
|
|
} from '../util/whatTypeOfConversation';
|
|
import { SignalService as Proto } from '../protobuf';
|
|
import {
|
|
getMessagePropStatus,
|
|
hasErrors,
|
|
isIncoming,
|
|
isStory,
|
|
} from '../state/selectors/message';
|
|
import {
|
|
conversationJobQueue,
|
|
conversationQueueJobEnum,
|
|
} from '../jobs/conversationJobQueue';
|
|
import type { ReactionAttributesType } from '../messageModifiers/Reactions';
|
|
import { getProfile } from '../util/getProfile';
|
|
import { SEALED_SENDER } from '../types/SealedSender';
|
|
import { createIdenticon } from '../util/createIdenticon';
|
|
import * as log from '../logging/log';
|
|
import * as Errors from '../types/errors';
|
|
import { isMessageUnread } from '../util/isMessageUnread';
|
|
import type { SenderKeyTargetType } from '../util/sendToGroup';
|
|
import { resetSenderKey, sendContentMessageToGroup } from '../util/sendToGroup';
|
|
import { singleProtoJobQueue } from '../jobs/singleProtoJobQueue';
|
|
import { TimelineMessageLoadingState } from '../util/timelineUtil';
|
|
import { SeenStatus } from '../MessageSeenStatus';
|
|
import { getConversationIdForLogging } from '../util/idForLogging';
|
|
import { getSendTarget } from '../util/getSendTarget';
|
|
import { getRecipients } from '../util/getRecipients';
|
|
import { validateConversation } from '../util/validateConversation';
|
|
import { isSignalConversation } from '../util/isSignalConversation';
|
|
import { removePendingMember } from '../util/removePendingMember';
|
|
import {
|
|
isMember,
|
|
isMemberAwaitingApproval,
|
|
isMemberBanned,
|
|
isMemberPending,
|
|
isMemberRequestingToJoin,
|
|
} from '../util/groupMembershipUtils';
|
|
import { imageToBlurHash } from '../util/imageToBlurHash';
|
|
import { ReceiptType } from '../types/Receipt';
|
|
import { getQuoteAttachment } from '../util/makeQuote';
|
|
import { deriveProfileKeyVersion } from '../util/zkgroup';
|
|
import { incrementMessageCounter } from '../util/incrementMessageCounter';
|
|
import OS from '../util/os/osMain';
|
|
import { getMessageAuthorText } from '../util/getMessageAuthorText';
|
|
import { downscaleOutgoingAttachment } from '../util/attachments';
|
|
import { MessageRequestResponseEvent } from '../types/MessageRequestResponseEvent';
|
|
|
|
/* eslint-disable more/no-then */
|
|
window.Whisper = window.Whisper || {};
|
|
|
|
const { Message } = window.Signal.Types;
|
|
const {
|
|
deleteAttachmentData,
|
|
doesAttachmentExist,
|
|
getAbsoluteAttachmentPath,
|
|
getAbsoluteTempPath,
|
|
readStickerData,
|
|
upgradeMessageSchema,
|
|
writeNewAttachmentData,
|
|
} = window.Signal.Migrations;
|
|
const {
|
|
addStickerPackReference,
|
|
getConversationRangeCenteredOnMessage,
|
|
getOlderMessagesByConversation,
|
|
getMessageMetricsForConversation,
|
|
getMessageById,
|
|
getNewerMessagesByConversation,
|
|
} = window.Signal.Data;
|
|
|
|
const FIVE_MINUTES = MINUTE * 5;
|
|
const FETCH_TIMEOUT = SECOND * 30;
|
|
|
|
const JOB_REPORTING_THRESHOLD_MS = 25;
|
|
const SEND_REPORTING_THRESHOLD_MS = 25;
|
|
|
|
const MESSAGE_LOAD_CHUNK_SIZE = 30;
|
|
|
|
const ATTRIBUTES_THAT_DONT_INVALIDATE_PROPS_CACHE = new Set([
|
|
'lastProfile',
|
|
'profileLastFetchedAt',
|
|
'needsStorageServiceSync',
|
|
'storageID',
|
|
'storageVersion',
|
|
'storageUnknownFields',
|
|
]);
|
|
|
|
type CachedIdenticon = {
|
|
readonly color: AvatarColorType;
|
|
readonly text?: string;
|
|
readonly path?: string;
|
|
readonly url: string;
|
|
};
|
|
|
|
export class ConversationModel extends window.Backbone
|
|
.Model<ConversationAttributesType> {
|
|
static COLORS: string;
|
|
|
|
cachedProps?: ConversationType | null;
|
|
|
|
oldCachedProps?: ConversationType | null;
|
|
|
|
contactTypingTimers?: Record<
|
|
string,
|
|
{
|
|
senderId: string;
|
|
timer: NodeJS.Timer;
|
|
timestamp: number;
|
|
}
|
|
>;
|
|
|
|
contactCollection?: Backbone.Collection<ConversationModel>;
|
|
|
|
debouncedUpdateLastMessage: (() => void) & { flush(): void };
|
|
|
|
initialPromise?: Promise<unknown>;
|
|
|
|
inProgressFetch?: Promise<unknown>;
|
|
|
|
newMessageQueue?: PQueue;
|
|
|
|
jobQueue?: PQueue;
|
|
|
|
storeName?: string | null;
|
|
|
|
throttledBumpTyping?: () => void;
|
|
|
|
throttledFetchSMSOnlyUUID?: () => Promise<void> | undefined;
|
|
|
|
throttledMaybeMigrateV1Group?: () => Promise<void> | undefined;
|
|
|
|
throttledGetProfiles?: () => Promise<void>;
|
|
|
|
throttledUpdateVerified?: () => void;
|
|
|
|
typingRefreshTimer?: NodeJS.Timer | null;
|
|
|
|
typingPauseTimer?: NodeJS.Timer | null;
|
|
|
|
intlCollator = new Intl.Collator(undefined, { sensitivity: 'base' });
|
|
|
|
lastSuccessfulGroupFetch?: number;
|
|
|
|
throttledUpdateSharedGroups?: () => Promise<void>;
|
|
|
|
private cachedIdenticon?: CachedIdenticon;
|
|
|
|
public isFetchingUUID?: boolean;
|
|
|
|
private lastIsTyping?: boolean;
|
|
|
|
private muteTimer?: NodeJS.Timer;
|
|
|
|
private isInReduxBatch = false;
|
|
|
|
private privVerifiedEnum?: typeof window.textsecure.storage.protocol.VerifiedStatus;
|
|
|
|
private isShuttingDown = false;
|
|
|
|
override defaults(): Partial<ConversationAttributesType> {
|
|
return {
|
|
unreadCount: 0,
|
|
verified: window.textsecure.storage.protocol.VerifiedStatus.DEFAULT,
|
|
messageCount: 0,
|
|
sentMessageCount: 0,
|
|
};
|
|
}
|
|
|
|
idForLogging(): string {
|
|
return getConversationIdForLogging(this.attributes);
|
|
}
|
|
|
|
getSendTarget(): ServiceIdString | undefined {
|
|
return getSendTarget(this.attributes);
|
|
}
|
|
|
|
getContactCollection(): Backbone.Collection<ConversationModel> {
|
|
const collection = new window.Backbone.Collection<ConversationModel>();
|
|
const collator = new Intl.Collator(undefined, { sensitivity: 'base' });
|
|
collection.comparator = (
|
|
left: ConversationModel,
|
|
right: ConversationModel
|
|
) => {
|
|
return collator.compare(left.getTitle(), right.getTitle());
|
|
};
|
|
return collection;
|
|
}
|
|
|
|
constructor(attributes: ConversationAttributesType) {
|
|
super(attributes);
|
|
|
|
// Note that we intentionally don't use `initialize()` method because it
|
|
// isn't compatible with esnext output of esbuild.
|
|
const serviceId = this.getServiceId();
|
|
const normalizedServiceId =
|
|
serviceId &&
|
|
normalizeServiceId(serviceId, 'ConversationModel.initialize');
|
|
if (serviceId && normalizedServiceId !== serviceId) {
|
|
log.warn(
|
|
'ConversationModel.initialize: normalizing serviceId from ' +
|
|
`${serviceId} to ${normalizedServiceId}`
|
|
);
|
|
this.set('serviceId', normalizedServiceId);
|
|
}
|
|
|
|
if (isValidE164(attributes.id, false)) {
|
|
this.set({ id: generateGuid(), e164: attributes.id });
|
|
}
|
|
|
|
this.storeName = 'conversations';
|
|
|
|
this.privVerifiedEnum = window.textsecure.storage.protocol.VerifiedStatus;
|
|
|
|
// This may be overridden by window.ConversationController.getOrCreate, and signify
|
|
// our first save to the database. Or first fetch from the database.
|
|
this.initialPromise = Promise.resolve();
|
|
|
|
this.debouncedUpdateLastMessage = debounce(
|
|
this.updateLastMessage.bind(this),
|
|
200
|
|
);
|
|
|
|
this.contactCollection = this.getContactCollection();
|
|
this.contactCollection.on(
|
|
'change:name change:profileName change:profileFamilyName change:e164',
|
|
this.debouncedUpdateLastMessage,
|
|
this
|
|
);
|
|
if (!isDirectConversation(this.attributes)) {
|
|
this.contactCollection.on(
|
|
'change:verified',
|
|
this.onMemberVerifiedChange.bind(this)
|
|
);
|
|
}
|
|
|
|
this.on('newmessage', this.onNewMessage);
|
|
this.on('change:profileKey', this.onChangeProfileKey);
|
|
this.on(
|
|
'change:name change:profileName change:profileFamilyName change:e164 ' +
|
|
'change:systemGivenName change:systemFamilyName change:systemNickname',
|
|
() => this.maybeClearUsername()
|
|
);
|
|
|
|
const sealedSender = this.get('sealedSender');
|
|
if (sealedSender === undefined) {
|
|
this.set({ sealedSender: SEALED_SENDER.UNKNOWN });
|
|
}
|
|
// @ts-expect-error -- Removing legacy prop
|
|
this.unset('unidentifiedDelivery');
|
|
// @ts-expect-error -- Removing legacy prop
|
|
this.unset('unidentifiedDeliveryUnrestricted');
|
|
// @ts-expect-error -- Removing legacy prop
|
|
this.unset('hasFetchedProfile');
|
|
// @ts-expect-error -- Removing legacy prop
|
|
this.unset('tokens');
|
|
|
|
this.on('change:members change:membersV2', this.fetchContacts);
|
|
this.typingRefreshTimer = null;
|
|
this.typingPauseTimer = null;
|
|
|
|
// We clear our cached props whenever we change so that the next call to format() will
|
|
// result in refresh via a getProps() call. See format() below.
|
|
this.on(
|
|
'change',
|
|
(_model: MessageModel, options: { force?: boolean } = {}) => {
|
|
const changedKeys = Object.keys(this.changed || {});
|
|
const isPropsCacheStillValid =
|
|
!options.force &&
|
|
Boolean(
|
|
changedKeys.length &&
|
|
changedKeys.every(key =>
|
|
ATTRIBUTES_THAT_DONT_INVALIDATE_PROPS_CACHE.has(key)
|
|
)
|
|
);
|
|
if (isPropsCacheStillValid) {
|
|
return;
|
|
}
|
|
|
|
if (this.cachedProps) {
|
|
this.oldCachedProps = this.cachedProps;
|
|
}
|
|
this.cachedProps = null;
|
|
this.trigger('props-change', this, this.isInReduxBatch);
|
|
}
|
|
);
|
|
|
|
// Set `isFetchingUUID` eagerly to avoid UI flicker when opening the
|
|
// conversation for the first time.
|
|
this.isFetchingUUID = this.isSMSOnly();
|
|
|
|
this.throttledBumpTyping = throttle(this.bumpTyping, 300);
|
|
this.throttledUpdateSharedGroups = throttle(
|
|
this.updateSharedGroups.bind(this),
|
|
FIVE_MINUTES
|
|
);
|
|
this.throttledFetchSMSOnlyUUID = throttle(
|
|
this.fetchSMSOnlyUUID.bind(this),
|
|
FIVE_MINUTES
|
|
);
|
|
this.throttledMaybeMigrateV1Group = throttle(
|
|
this.maybeMigrateV1Group.bind(this),
|
|
FIVE_MINUTES
|
|
);
|
|
this.throttledGetProfiles = throttle(
|
|
this.getProfiles.bind(this),
|
|
FIVE_MINUTES
|
|
);
|
|
this.throttledUpdateVerified = throttle(
|
|
this.updateVerified.bind(this),
|
|
SECOND
|
|
);
|
|
|
|
this.on('newmessage', this.throttledUpdateVerified);
|
|
|
|
const migratedColor = this.getColor();
|
|
if (this.get('color') !== migratedColor) {
|
|
this.set('color', migratedColor);
|
|
// Not saving the conversation here we're hoping it'll be saved elsewhere
|
|
// this may cause some color thrashing if Signal is restarted without
|
|
// the convo saving. If that is indeed the case and it's too disruptive
|
|
// we should add batched saving.
|
|
}
|
|
}
|
|
|
|
toSenderKeyTarget(): SenderKeyTargetType {
|
|
return {
|
|
getGroupId: () => this.get('groupId'),
|
|
getMembers: () => this.getMembers(),
|
|
hasMember: (serviceId: ServiceIdString) => this.hasMember(serviceId),
|
|
idForLogging: () => this.idForLogging(),
|
|
isGroupV2: () => isGroupV2(this.attributes),
|
|
isValid: () => isGroupV2(this.attributes),
|
|
|
|
getSenderKeyInfo: () => this.get('senderKeyInfo'),
|
|
saveSenderKeyInfo: async (senderKeyInfo: SenderKeyInfoType) => {
|
|
this.set({ senderKeyInfo });
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
},
|
|
};
|
|
}
|
|
|
|
private get verifiedEnum(): typeof window.textsecure.storage.protocol.VerifiedStatus {
|
|
strictAssert(this.privVerifiedEnum, 'ConversationModel not initialize');
|
|
return this.privVerifiedEnum;
|
|
}
|
|
|
|
private isMemberRequestingToJoin(serviceId: ServiceIdString): boolean {
|
|
return isMemberRequestingToJoin(this.attributes, serviceId);
|
|
}
|
|
|
|
isMemberPending(serviceId: ServiceIdString): boolean {
|
|
return isMemberPending(this.attributes, serviceId);
|
|
}
|
|
|
|
isMemberAwaitingApproval(serviceId: ServiceIdString): boolean {
|
|
return isMemberAwaitingApproval(this.attributes, serviceId);
|
|
}
|
|
|
|
isMember(serviceId: ServiceIdString): boolean {
|
|
return isMember(this.attributes, serviceId);
|
|
}
|
|
|
|
async updateExpirationTimerInGroupV2(
|
|
seconds?: DurationInSeconds
|
|
): Promise<Proto.GroupChange.Actions | undefined> {
|
|
const idLog = this.idForLogging();
|
|
const current = this.get('expireTimer');
|
|
const bothFalsey = Boolean(current) === false && Boolean(seconds) === false;
|
|
|
|
if (current === seconds || bothFalsey) {
|
|
log.warn(
|
|
`updateExpirationTimerInGroupV2/${idLog}: Requested timer ${seconds} is unchanged from existing ${current}.`
|
|
);
|
|
return undefined;
|
|
}
|
|
|
|
return window.Signal.Groups.buildDisappearingMessagesTimerChange({
|
|
expireTimer: seconds || DurationInSeconds.ZERO,
|
|
group: this.attributes,
|
|
});
|
|
}
|
|
|
|
private async promotePendingMember(
|
|
serviceIdKind: ServiceIdKind
|
|
): Promise<Proto.GroupChange.Actions | undefined> {
|
|
const idLog = this.idForLogging();
|
|
|
|
const us = window.ConversationController.getOurConversationOrThrow();
|
|
const serviceId = window.storage.user.getCheckedServiceId(serviceIdKind);
|
|
|
|
// This user's pending state may have changed in the time between the user's
|
|
// button press and when we get here. It's especially important to check here
|
|
// in conflict/retry cases.
|
|
if (!this.isMemberPending(serviceId)) {
|
|
log.warn(
|
|
`promotePendingMember/${idLog}: we are not a pending member of group. Returning early.`
|
|
);
|
|
return undefined;
|
|
}
|
|
|
|
// We need the user's profileKeyCredential, which requires a roundtrip with the
|
|
// server, and most definitely their profileKey. A getProfiles() call will
|
|
// ensure that we have as much as we can get with the data we have.
|
|
if (!us.get('profileKeyCredential')) {
|
|
await us.getProfiles();
|
|
}
|
|
|
|
const profileKeyCredentialBase64 = us.get('profileKeyCredential');
|
|
strictAssert(profileKeyCredentialBase64, 'Must have profileKeyCredential');
|
|
|
|
if (serviceIdKind === ServiceIdKind.ACI) {
|
|
return window.Signal.Groups.buildPromoteMemberChange({
|
|
group: this.attributes,
|
|
isPendingPniAciProfileKey: false,
|
|
profileKeyCredentialBase64,
|
|
serverPublicParamsBase64: window.getServerPublicParams(),
|
|
});
|
|
}
|
|
|
|
strictAssert(
|
|
serviceIdKind === ServiceIdKind.PNI,
|
|
'Must be a PNI promotion'
|
|
);
|
|
|
|
return window.Signal.Groups.buildPromoteMemberChange({
|
|
group: this.attributes,
|
|
isPendingPniAciProfileKey: true,
|
|
profileKeyCredentialBase64,
|
|
serverPublicParamsBase64: window.getServerPublicParams(),
|
|
});
|
|
}
|
|
|
|
private async denyPendingApprovalRequest(
|
|
aci: AciString
|
|
): Promise<Proto.GroupChange.Actions | undefined> {
|
|
const idLog = this.idForLogging();
|
|
|
|
// This user's pending state may have changed in the time between the user's
|
|
// button press and when we get here. It's especially important to check here
|
|
// in conflict/retry cases.
|
|
if (!this.isMemberRequestingToJoin(aci)) {
|
|
log.warn(
|
|
`denyPendingApprovalRequest/${idLog}: ${aci} is not requesting ` +
|
|
'to join the group. Returning early.'
|
|
);
|
|
return undefined;
|
|
}
|
|
|
|
const ourAci = window.textsecure.storage.user.getCheckedAci();
|
|
|
|
return window.Signal.Groups.buildDeletePendingAdminApprovalMemberChange({
|
|
group: this.attributes,
|
|
ourAci,
|
|
aci,
|
|
});
|
|
}
|
|
|
|
async addPendingApprovalRequest(): Promise<
|
|
Proto.GroupChange.Actions | undefined
|
|
> {
|
|
const idLog = this.idForLogging();
|
|
|
|
// Hard-coded to our own ID, because you don't add other users for admin approval
|
|
const conversationId =
|
|
window.ConversationController.getOurConversationIdOrThrow();
|
|
|
|
const toRequest = window.ConversationController.get(conversationId);
|
|
if (!toRequest) {
|
|
throw new Error(
|
|
`addPendingApprovalRequest/${idLog}: No conversation found for conversation ${conversationId}`
|
|
);
|
|
}
|
|
|
|
const serviceId = toRequest.getCheckedServiceId(
|
|
`addPendingApprovalRequest/${idLog}`
|
|
);
|
|
|
|
// We need the user's profileKeyCredential, which requires a roundtrip with the
|
|
// server, and most definitely their profileKey. A getProfiles() call will
|
|
// ensure that we have as much as we can get with the data we have.
|
|
let profileKeyCredentialBase64 = toRequest.get('profileKeyCredential');
|
|
if (!profileKeyCredentialBase64) {
|
|
await toRequest.getProfiles();
|
|
|
|
profileKeyCredentialBase64 = toRequest.get('profileKeyCredential');
|
|
if (!profileKeyCredentialBase64) {
|
|
throw new Error(
|
|
`promotePendingMember/${idLog}: No profileKeyCredential for conversation ${toRequest.idForLogging()}`
|
|
);
|
|
}
|
|
}
|
|
|
|
// This user's pending state may have changed in the time between the user's
|
|
// button press and when we get here. It's especially important to check here
|
|
// in conflict/retry cases.
|
|
if (this.isMemberAwaitingApproval(serviceId)) {
|
|
log.warn(
|
|
`addPendingApprovalRequest/${idLog}: ` +
|
|
`${toRequest.idForLogging()} already in pending approval.`
|
|
);
|
|
return undefined;
|
|
}
|
|
|
|
return window.Signal.Groups.buildAddPendingAdminApprovalMemberChange({
|
|
group: this.attributes,
|
|
profileKeyCredentialBase64,
|
|
serverPublicParamsBase64: window.getServerPublicParams(),
|
|
});
|
|
}
|
|
|
|
async addMember(
|
|
serviceId: ServiceIdString
|
|
): Promise<Proto.GroupChange.Actions | undefined> {
|
|
const idLog = this.idForLogging();
|
|
|
|
const toRequest = window.ConversationController.get(serviceId);
|
|
if (!toRequest) {
|
|
throw new Error(
|
|
`addMember/${idLog}: No conversation found for ${serviceId}`
|
|
);
|
|
}
|
|
|
|
// We need the user's profileKeyCredential, which requires a roundtrip with the
|
|
// server, and most definitely their profileKey. A getProfiles() call will
|
|
// ensure that we have as much as we can get with the data we have.
|
|
let profileKeyCredentialBase64 = toRequest.get('profileKeyCredential');
|
|
if (!profileKeyCredentialBase64) {
|
|
await toRequest.getProfiles();
|
|
|
|
profileKeyCredentialBase64 = toRequest.get('profileKeyCredential');
|
|
if (!profileKeyCredentialBase64) {
|
|
throw new Error(
|
|
`addMember/${idLog}: No profileKeyCredential for conversation ${toRequest.idForLogging()}`
|
|
);
|
|
}
|
|
}
|
|
|
|
// This user's pending state may have changed in the time between the user's
|
|
// button press and when we get here. It's especially important to check here
|
|
// in conflict/retry cases.
|
|
if (this.isMember(serviceId)) {
|
|
log.warn(
|
|
`addMember/${idLog}: ${toRequest.idForLogging()} ` +
|
|
'is already a member.'
|
|
);
|
|
return undefined;
|
|
}
|
|
|
|
return window.Signal.Groups.buildAddMember({
|
|
group: this.attributes,
|
|
profileKeyCredentialBase64,
|
|
serverPublicParamsBase64: window.getServerPublicParams(),
|
|
serviceId,
|
|
});
|
|
}
|
|
|
|
private async removePendingMember(
|
|
serviceIds: ReadonlyArray<ServiceIdString>
|
|
): Promise<Proto.GroupChange.Actions | undefined> {
|
|
return removePendingMember(this.attributes, serviceIds);
|
|
}
|
|
|
|
private async removeMember(
|
|
serviceId: ServiceIdString
|
|
): Promise<Proto.GroupChange.Actions | undefined> {
|
|
const idLog = this.idForLogging();
|
|
|
|
// This user's pending state may have changed in the time between the user's
|
|
// button press and when we get here. It's especially important to check here
|
|
// in conflict/retry cases.
|
|
if (!this.isMember(serviceId)) {
|
|
log.warn(
|
|
`removeMember/${idLog}: ${serviceId} is not a pending member of group. Returning early.`
|
|
);
|
|
return undefined;
|
|
}
|
|
|
|
const ourAci = window.textsecure.storage.user.getCheckedAci();
|
|
|
|
return window.Signal.Groups.buildDeleteMemberChange({
|
|
group: this.attributes,
|
|
ourAci,
|
|
serviceId,
|
|
});
|
|
}
|
|
|
|
private async toggleAdminChange(
|
|
serviceId: ServiceIdString
|
|
): Promise<Proto.GroupChange.Actions | undefined> {
|
|
if (!isGroupV2(this.attributes)) {
|
|
return undefined;
|
|
}
|
|
|
|
const idLog = this.idForLogging();
|
|
|
|
if (!this.isMember(serviceId)) {
|
|
log.warn(
|
|
`toggleAdminChange/${idLog}: ${serviceId} is not a pending member of group. Returning early.`
|
|
);
|
|
return undefined;
|
|
}
|
|
|
|
const MEMBER_ROLES = Proto.Member.Role;
|
|
|
|
const role = this.isAdmin(serviceId)
|
|
? MEMBER_ROLES.DEFAULT
|
|
: MEMBER_ROLES.ADMINISTRATOR;
|
|
|
|
return window.Signal.Groups.buildModifyMemberRoleChange({
|
|
group: this.attributes,
|
|
serviceId,
|
|
role,
|
|
});
|
|
}
|
|
|
|
async modifyGroupV2({
|
|
usingCredentialsFrom,
|
|
createGroupChange,
|
|
extraConversationsForSend,
|
|
inviteLinkPassword,
|
|
name,
|
|
syncMessageOnly,
|
|
}: {
|
|
usingCredentialsFrom: ReadonlyArray<ConversationModel>;
|
|
createGroupChange: () => Promise<Proto.GroupChange.Actions | undefined>;
|
|
extraConversationsForSend?: ReadonlyArray<string>;
|
|
inviteLinkPassword?: string;
|
|
name: string;
|
|
syncMessageOnly?: boolean;
|
|
}): Promise<void> {
|
|
await window.Signal.Groups.modifyGroupV2({
|
|
conversation: this,
|
|
usingCredentialsFrom,
|
|
createGroupChange,
|
|
extraConversationsForSend,
|
|
inviteLinkPassword,
|
|
name,
|
|
syncMessageOnly,
|
|
});
|
|
}
|
|
|
|
isEverUnregistered(): boolean {
|
|
return isConversationEverUnregistered(this.attributes);
|
|
}
|
|
|
|
isUnregistered(): boolean {
|
|
return isConversationUnregistered(this.attributes);
|
|
}
|
|
|
|
isUnregisteredAndStale(): boolean {
|
|
return isConversationUnregisteredAndStale(this.attributes);
|
|
}
|
|
|
|
isSMSOnly(): boolean {
|
|
return isConversationSMSOnly({
|
|
...this.attributes,
|
|
type: isDirectConversation(this.attributes) ? 'direct' : 'unknown',
|
|
});
|
|
}
|
|
|
|
setUnregistered({
|
|
timestamp = Date.now(),
|
|
fromStorageService = false,
|
|
shouldSave = true,
|
|
}: {
|
|
timestamp?: number;
|
|
fromStorageService?: boolean;
|
|
shouldSave?: boolean;
|
|
} = {}): void {
|
|
log.info(
|
|
`setUnregistered(${this.idForLogging()}): conversation is now ` +
|
|
`unregistered, timestamp=${timestamp}`
|
|
);
|
|
|
|
const oldFirstUnregisteredAt = this.get('firstUnregisteredAt');
|
|
|
|
this.set({
|
|
// We always keep the latest `discoveredUnregisteredAt` because if it
|
|
// was less than 6 hours ago - `isUnregistered()` has to return `false`
|
|
// and let us retry sends.
|
|
discoveredUnregisteredAt: Math.max(
|
|
this.get('discoveredUnregisteredAt') ?? timestamp,
|
|
timestamp
|
|
),
|
|
|
|
// Here we keep the oldest `firstUnregisteredAt` unless timestamp is
|
|
// coming from storage service where remote value always wins.
|
|
firstUnregisteredAt: fromStorageService
|
|
? timestamp
|
|
: Math.min(this.get('firstUnregisteredAt') ?? timestamp, timestamp),
|
|
});
|
|
|
|
if (shouldSave) {
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
}
|
|
|
|
const e164 = this.get('e164');
|
|
const pni = this.getPni();
|
|
const aci = this.getServiceId();
|
|
if (e164 && pni && aci && pni !== aci) {
|
|
this.updateE164(undefined);
|
|
this.updatePni(undefined, false);
|
|
|
|
const { conversation: split } =
|
|
window.ConversationController.maybeMergeContacts({
|
|
pni,
|
|
e164,
|
|
reason: `ConversationModel.setUnregistered(${aci})`,
|
|
});
|
|
|
|
log.info(
|
|
`setUnregistered(${this.idForLogging()}): splitting pni ${pni} and ` +
|
|
`e164 ${e164} into a separate conversation ${split.idForLogging()}`
|
|
);
|
|
}
|
|
|
|
if (
|
|
!fromStorageService &&
|
|
oldFirstUnregisteredAt !== this.get('firstUnregisteredAt')
|
|
) {
|
|
this.captureChange('setUnregistered');
|
|
}
|
|
}
|
|
|
|
setRegistered({
|
|
shouldSave = true,
|
|
fromStorageService = false,
|
|
}: {
|
|
shouldSave?: boolean;
|
|
fromStorageService?: boolean;
|
|
} = {}): void {
|
|
if (
|
|
this.get('discoveredUnregisteredAt') === undefined &&
|
|
this.get('firstUnregisteredAt') === undefined
|
|
) {
|
|
return;
|
|
}
|
|
|
|
const oldFirstUnregisteredAt = this.get('firstUnregisteredAt');
|
|
|
|
log.info(`Conversation ${this.idForLogging()} is registered once again`);
|
|
this.set({
|
|
discoveredUnregisteredAt: undefined,
|
|
firstUnregisteredAt: undefined,
|
|
});
|
|
|
|
if (shouldSave) {
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
}
|
|
|
|
if (
|
|
!fromStorageService &&
|
|
oldFirstUnregisteredAt !== this.get('firstUnregisteredAt')
|
|
) {
|
|
this.captureChange('setRegistered');
|
|
}
|
|
}
|
|
|
|
isGroupV1AndDisabled(): boolean {
|
|
return isGroupV1(this.attributes);
|
|
}
|
|
|
|
isBlocked(): boolean {
|
|
return isBlocked(this.attributes);
|
|
}
|
|
|
|
block({ viaStorageServiceSync = false } = {}): void {
|
|
let blocked = false;
|
|
const wasBlocked = this.isBlocked();
|
|
|
|
const serviceId = this.getServiceId();
|
|
if (serviceId) {
|
|
drop(window.storage.blocked.addBlockedServiceId(serviceId));
|
|
blocked = true;
|
|
}
|
|
|
|
const e164 = this.get('e164');
|
|
if (e164) {
|
|
drop(window.storage.blocked.addBlockedNumber(e164));
|
|
blocked = true;
|
|
}
|
|
|
|
const groupId = this.get('groupId');
|
|
if (groupId) {
|
|
drop(window.storage.blocked.addBlockedGroup(groupId));
|
|
blocked = true;
|
|
}
|
|
|
|
if (blocked && !wasBlocked) {
|
|
// We need to force a props refresh - blocked state is not in backbone attributes
|
|
this.trigger('change', this, { force: true });
|
|
|
|
if (!viaStorageServiceSync) {
|
|
this.captureChange('block');
|
|
}
|
|
}
|
|
}
|
|
|
|
unblock({ viaStorageServiceSync = false } = {}): boolean {
|
|
let unblocked = false;
|
|
const wasBlocked = this.isBlocked();
|
|
|
|
const serviceId = this.getServiceId();
|
|
if (serviceId) {
|
|
drop(window.storage.blocked.removeBlockedServiceId(serviceId));
|
|
unblocked = true;
|
|
}
|
|
|
|
const e164 = this.get('e164');
|
|
if (e164) {
|
|
drop(window.storage.blocked.removeBlockedNumber(e164));
|
|
unblocked = true;
|
|
}
|
|
|
|
const groupId = this.get('groupId');
|
|
if (groupId) {
|
|
drop(window.storage.blocked.removeBlockedGroup(groupId));
|
|
unblocked = true;
|
|
}
|
|
|
|
if (unblocked && wasBlocked) {
|
|
// We need to force a props refresh - blocked state is not in backbone attributes
|
|
this.trigger('change', this, { force: true });
|
|
|
|
if (!viaStorageServiceSync) {
|
|
this.captureChange('unblock');
|
|
}
|
|
|
|
void this.fetchLatestGroupV2Data({ force: true });
|
|
}
|
|
|
|
return unblocked;
|
|
}
|
|
|
|
async removeContact({
|
|
viaStorageServiceSync = false,
|
|
shouldSave = true,
|
|
} = {}): Promise<void> {
|
|
const logId = `removeContact(${this.idForLogging()}) storage? ${viaStorageServiceSync}`;
|
|
|
|
if (!isDirectConversation(this.attributes)) {
|
|
log.warn(`${logId}: not direct conversation`);
|
|
return;
|
|
}
|
|
|
|
if (this.get('removalStage')) {
|
|
log.warn(`${logId}: already removed`);
|
|
return;
|
|
}
|
|
|
|
// Don't show message request state until first incoming message.
|
|
log.info(`${logId}: updating`);
|
|
this.set({ removalStage: 'justNotification' });
|
|
|
|
if (!viaStorageServiceSync) {
|
|
this.captureChange('removeContact');
|
|
}
|
|
|
|
this.disableProfileSharing({ viaStorageServiceSync });
|
|
|
|
// Drop existing message request state to avoid sending receipts and
|
|
// display MR actions.
|
|
const messageRequestEnum = Proto.SyncMessage.MessageRequestResponse.Type;
|
|
await this.applyMessageRequestResponse(messageRequestEnum.UNKNOWN, {
|
|
viaStorageServiceSync,
|
|
shouldSave: false,
|
|
});
|
|
|
|
window.reduxActions?.stories.removeAllContactStories(this.id);
|
|
const serviceId = this.getServiceId();
|
|
if (serviceId) {
|
|
window.reduxActions?.storyDistributionLists.removeMemberFromAllDistributionLists(
|
|
serviceId
|
|
);
|
|
}
|
|
|
|
// Add notification
|
|
drop(this.queueJob('removeContact', () => this.maybeSetContactRemoved()));
|
|
|
|
if (shouldSave) {
|
|
await window.Signal.Data.updateConversation(this.attributes);
|
|
}
|
|
}
|
|
|
|
async restoreContact({
|
|
viaStorageServiceSync = false,
|
|
shouldSave = true,
|
|
} = {}): Promise<void> {
|
|
const logId = `restoreContact(${this.idForLogging()}) storage? ${viaStorageServiceSync}`;
|
|
|
|
if (!isDirectConversation(this.attributes)) {
|
|
log.warn(`${logId}: not direct conversation`);
|
|
return;
|
|
}
|
|
|
|
if (this.get('removalStage') === undefined) {
|
|
if (!viaStorageServiceSync) {
|
|
log.warn(`${logId}: not removed`);
|
|
}
|
|
return;
|
|
}
|
|
|
|
log.info(`${logId}: updating`);
|
|
this.set({ removalStage: undefined });
|
|
|
|
if (!viaStorageServiceSync) {
|
|
this.captureChange('restoreContact');
|
|
}
|
|
|
|
// Remove notification since the conversation isn't hidden anymore
|
|
await this.maybeClearContactRemoved();
|
|
|
|
if (shouldSave) {
|
|
await window.Signal.Data.updateConversation(this.attributes);
|
|
}
|
|
}
|
|
|
|
enableProfileSharing({ viaStorageServiceSync = false } = {}): void {
|
|
log.info(
|
|
`enableProfileSharing: ${this.idForLogging()} storage? ${viaStorageServiceSync}`
|
|
);
|
|
const before = this.get('profileSharing');
|
|
|
|
this.set({ profileSharing: true });
|
|
|
|
const after = this.get('profileSharing');
|
|
|
|
if (!viaStorageServiceSync && Boolean(before) !== Boolean(after)) {
|
|
this.captureChange('enableProfileSharing');
|
|
}
|
|
}
|
|
|
|
disableProfileSharing({ viaStorageServiceSync = false } = {}): void {
|
|
log.info(
|
|
`disableProfileSharing: ${this.idForLogging()} storage? ${viaStorageServiceSync}`
|
|
);
|
|
const before = this.get('profileSharing');
|
|
|
|
this.set({ profileSharing: false });
|
|
|
|
const after = this.get('profileSharing');
|
|
|
|
if (!viaStorageServiceSync && Boolean(before) !== Boolean(after)) {
|
|
this.captureChange('disableProfileSharing');
|
|
}
|
|
}
|
|
|
|
hasDraft(): boolean {
|
|
return hasDraft(this.attributes);
|
|
}
|
|
|
|
getDraftPreview(): DraftPreviewType {
|
|
return getDraftPreview(this.attributes);
|
|
}
|
|
|
|
bumpTyping(): void {
|
|
// We don't send typing messages if the setting is disabled
|
|
if (!window.Events.getTypingIndicatorSetting()) {
|
|
return;
|
|
}
|
|
|
|
if (!this.typingRefreshTimer) {
|
|
const isTyping = true;
|
|
this.setTypingRefreshTimer();
|
|
void this.sendTypingMessage(isTyping);
|
|
}
|
|
|
|
this.setTypingPauseTimer();
|
|
}
|
|
|
|
setTypingRefreshTimer(): void {
|
|
clearTimeoutIfNecessary(this.typingRefreshTimer);
|
|
this.typingRefreshTimer = setTimeout(
|
|
this.onTypingRefreshTimeout.bind(this),
|
|
10 * 1000
|
|
);
|
|
}
|
|
|
|
onTypingRefreshTimeout(): void {
|
|
const isTyping = true;
|
|
void this.sendTypingMessage(isTyping);
|
|
|
|
// This timer will continue to reset itself until the pause timer stops it
|
|
this.setTypingRefreshTimer();
|
|
}
|
|
|
|
setTypingPauseTimer(): void {
|
|
clearTimeoutIfNecessary(this.typingPauseTimer);
|
|
this.typingPauseTimer = setTimeout(
|
|
this.onTypingPauseTimeout.bind(this),
|
|
3 * 1000
|
|
);
|
|
}
|
|
|
|
onTypingPauseTimeout(): void {
|
|
const isTyping = false;
|
|
void this.sendTypingMessage(isTyping);
|
|
|
|
this.clearTypingTimers();
|
|
}
|
|
|
|
clearTypingTimers(): void {
|
|
clearTimeoutIfNecessary(this.typingPauseTimer);
|
|
this.typingPauseTimer = null;
|
|
clearTimeoutIfNecessary(this.typingRefreshTimer);
|
|
this.typingRefreshTimer = null;
|
|
}
|
|
|
|
async fetchLatestGroupV2Data(
|
|
options: { force?: boolean } = {}
|
|
): Promise<void> {
|
|
if (!isGroupV2(this.attributes)) {
|
|
return;
|
|
}
|
|
|
|
await window.Signal.Groups.waitThenMaybeUpdateGroup({
|
|
force: options.force,
|
|
conversation: this,
|
|
});
|
|
}
|
|
|
|
async fetchSMSOnlyUUID(): Promise<void> {
|
|
const { server } = window.textsecure;
|
|
if (!server) {
|
|
return;
|
|
}
|
|
if (!this.isSMSOnly()) {
|
|
return;
|
|
}
|
|
|
|
log.info(
|
|
`Fetching uuid for a sms-only conversation ${this.idForLogging()}`
|
|
);
|
|
|
|
this.isFetchingUUID = true;
|
|
this.trigger('change', this, { force: true });
|
|
|
|
try {
|
|
// Attempt to fetch UUID
|
|
await updateConversationsWithUuidLookup({
|
|
conversationController: window.ConversationController,
|
|
conversations: [this],
|
|
server,
|
|
});
|
|
} finally {
|
|
// No redux update here
|
|
this.isFetchingUUID = false;
|
|
this.trigger('change', this, { force: true });
|
|
|
|
log.info(
|
|
`Done fetching uuid for a sms-only conversation ${this.idForLogging()}`
|
|
);
|
|
}
|
|
|
|
if (!this.getServiceId()) {
|
|
return;
|
|
}
|
|
|
|
// On successful fetch - mark contact as registered.
|
|
this.setRegistered();
|
|
}
|
|
|
|
override isValid(): boolean {
|
|
return (
|
|
isDirectConversation(this.attributes) ||
|
|
isGroupV1(this.attributes) ||
|
|
isGroupV2(this.attributes)
|
|
);
|
|
}
|
|
|
|
async maybeMigrateV1Group(): Promise<void> {
|
|
if (!isGroupV1(this.attributes)) {
|
|
return;
|
|
}
|
|
|
|
const isMigrated = await window.Signal.Groups.hasV1GroupBeenMigrated(this);
|
|
if (!isMigrated) {
|
|
return;
|
|
}
|
|
|
|
await window.Signal.Groups.waitThenRespondToGroupV2Migration({
|
|
conversation: this,
|
|
});
|
|
}
|
|
|
|
maybeRepairGroupV2(data: {
|
|
masterKey: string;
|
|
secretParams: string;
|
|
publicParams: string;
|
|
}): void {
|
|
if (
|
|
this.get('groupVersion') &&
|
|
this.get('masterKey') &&
|
|
this.get('secretParams') &&
|
|
this.get('publicParams')
|
|
) {
|
|
return;
|
|
}
|
|
|
|
log.info(`Repairing GroupV2 conversation ${this.idForLogging()}`);
|
|
const { masterKey, secretParams, publicParams } = data;
|
|
|
|
this.set({ masterKey, secretParams, publicParams, groupVersion: 2 });
|
|
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
}
|
|
|
|
getGroupV2Info(
|
|
options: Readonly<
|
|
{ groupChange?: Uint8Array } & (
|
|
| {
|
|
includePendingMembers?: boolean;
|
|
extraConversationsForSend?: ReadonlyArray<string>;
|
|
}
|
|
| { members: ReadonlyArray<ServiceIdString> }
|
|
)
|
|
> = {}
|
|
): GroupV2InfoType | undefined {
|
|
if (isDirectConversation(this.attributes) || !isGroupV2(this.attributes)) {
|
|
return undefined;
|
|
}
|
|
return {
|
|
masterKey: Bytes.fromBase64(
|
|
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
|
|
this.get('masterKey')!
|
|
),
|
|
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
|
|
revision: this.get('revision')!,
|
|
members:
|
|
'members' in options ? options.members : this.getRecipients(options),
|
|
groupChange: options.groupChange,
|
|
};
|
|
}
|
|
|
|
getGroupIdBuffer(): Uint8Array | undefined {
|
|
const groupIdString = this.get('groupId');
|
|
|
|
if (!groupIdString) {
|
|
return undefined;
|
|
}
|
|
|
|
if (isGroupV1(this.attributes)) {
|
|
return Bytes.fromBinary(groupIdString);
|
|
}
|
|
if (isGroupV2(this.attributes)) {
|
|
return Bytes.fromBase64(groupIdString);
|
|
}
|
|
|
|
return undefined;
|
|
}
|
|
|
|
async sendTypingMessage(isTyping: boolean): Promise<void> {
|
|
const { messaging } = window.textsecure;
|
|
|
|
if (!messaging) {
|
|
return;
|
|
}
|
|
|
|
// We don't send typing messages to our other devices
|
|
if (isMe(this.attributes)) {
|
|
return;
|
|
}
|
|
|
|
// Coalesce multiple sendTypingMessage calls into one.
|
|
//
|
|
// `lastIsTyping` is set to the last `isTyping` value passed to the
|
|
// `sendTypingMessage`. The first 'sendTypingMessage' job to run will
|
|
// pick it and reset it back to `undefined` so that later jobs will
|
|
// in effect be ignored.
|
|
this.lastIsTyping = isTyping;
|
|
|
|
await this.queueJob('sendTypingMessage', async () => {
|
|
const groupMembers = this.getRecipients();
|
|
|
|
// We don't send typing messages if our recipients list is empty
|
|
if (!isDirectConversation(this.attributes) && !groupMembers.length) {
|
|
return;
|
|
}
|
|
|
|
if (this.lastIsTyping === undefined) {
|
|
log.info(`sendTypingMessage(${this.idForLogging()}): ignoring`);
|
|
return;
|
|
}
|
|
|
|
const recipientId = isDirectConversation(this.attributes)
|
|
? this.getSendTarget()
|
|
: undefined;
|
|
const groupId = this.getGroupIdBuffer();
|
|
const timestamp = Date.now();
|
|
|
|
const content = {
|
|
recipientId,
|
|
groupId,
|
|
groupMembers,
|
|
isTyping: this.lastIsTyping,
|
|
timestamp,
|
|
};
|
|
this.lastIsTyping = undefined;
|
|
|
|
log.info(
|
|
`sendTypingMessage(${this.idForLogging()}): sending ${content.isTyping}`
|
|
);
|
|
|
|
const contentMessage = messaging.getTypingContentMessage(content);
|
|
|
|
const { ContentHint } = Proto.UnidentifiedSenderMessage.Message;
|
|
|
|
const sendOptions = {
|
|
...(await getSendOptions(this.attributes)),
|
|
online: true,
|
|
};
|
|
if (isDirectConversation(this.attributes)) {
|
|
await handleMessageSend(
|
|
messaging.sendMessageProtoAndWait({
|
|
contentHint: ContentHint.IMPLICIT,
|
|
groupId: undefined,
|
|
options: sendOptions,
|
|
proto: contentMessage,
|
|
recipients: groupMembers,
|
|
timestamp,
|
|
urgent: false,
|
|
}),
|
|
{ messageIds: [], sendType: 'typing' }
|
|
);
|
|
} else {
|
|
await handleMessageSend(
|
|
sendContentMessageToGroup({
|
|
contentHint: ContentHint.IMPLICIT,
|
|
contentMessage,
|
|
messageId: undefined,
|
|
online: true,
|
|
recipients: groupMembers,
|
|
sendOptions,
|
|
sendTarget: this.toSenderKeyTarget(),
|
|
sendType: 'typing',
|
|
timestamp,
|
|
urgent: false,
|
|
}),
|
|
{ messageIds: [], sendType: 'typing' }
|
|
);
|
|
}
|
|
});
|
|
}
|
|
|
|
async onNewMessage(message: MessageModel): Promise<void> {
|
|
const serviceId = message.get('sourceServiceId');
|
|
const e164 = message.get('source');
|
|
const sourceDevice = message.get('sourceDevice');
|
|
|
|
const source = window.ConversationController.lookupOrCreate({
|
|
serviceId,
|
|
e164,
|
|
reason: 'ConversationModel.onNewMessage',
|
|
});
|
|
if (source) {
|
|
const typingToken = `${source.id}.${sourceDevice}`;
|
|
|
|
// Clear typing indicator for a given contact if we receive a message from them
|
|
this.clearContactTypingTimer(typingToken);
|
|
}
|
|
|
|
// If it's a group story reply or a story message, we don't want to update
|
|
// the last message or add new messages to redux.
|
|
const isGroupStoryReply =
|
|
isGroup(this.attributes) && message.get('storyId');
|
|
if (isGroupStoryReply || isStory(message.attributes)) {
|
|
return;
|
|
}
|
|
|
|
// Change to message request state if contact was removed and sent message.
|
|
if (
|
|
this.get('removalStage') === 'justNotification' &&
|
|
isIncoming(message.attributes)
|
|
) {
|
|
this.set({
|
|
removalStage: 'messageRequest',
|
|
});
|
|
await this.maybeClearContactRemoved();
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
}
|
|
|
|
void this.addSingleMessage(message);
|
|
}
|
|
|
|
// New messages might arrive while we're in the middle of a bulk fetch from the
|
|
// database. We'll wait until that is done before moving forward.
|
|
async addSingleMessage(
|
|
message: MessageModel,
|
|
{ isJustSent }: { isJustSent: boolean } = { isJustSent: false }
|
|
): Promise<void> {
|
|
await this.beforeAddSingleMessage(message);
|
|
this.doAddSingleMessage(message, { isJustSent });
|
|
this.debouncedUpdateLastMessage();
|
|
}
|
|
|
|
private async beforeAddSingleMessage(message: MessageModel): Promise<void> {
|
|
await message.hydrateStoryContext(undefined, { shouldSave: true });
|
|
|
|
if (!this.newMessageQueue) {
|
|
this.newMessageQueue = new PQueue({
|
|
concurrency: 1,
|
|
timeout: FETCH_TIMEOUT * 2,
|
|
});
|
|
}
|
|
|
|
// We use a queue here to ensure messages are added to the UI in the order received
|
|
await this.newMessageQueue.add(async () => {
|
|
await this.inProgressFetch;
|
|
});
|
|
}
|
|
|
|
private doAddSingleMessage(
|
|
message: MessageModel,
|
|
{ isJustSent }: { isJustSent: boolean }
|
|
): void {
|
|
const { messagesAdded } = window.reduxActions.conversations;
|
|
const { conversations } = window.reduxStore.getState();
|
|
const { messagesByConversation } = conversations;
|
|
|
|
const conversationId = this.id;
|
|
const existingConversation = messagesByConversation[conversationId];
|
|
const newestId = existingConversation?.metrics?.newest?.id;
|
|
const messageIds = existingConversation?.messageIds;
|
|
|
|
const isLatestInMemory =
|
|
newestId && messageIds && messageIds[messageIds.length - 1] === newestId;
|
|
|
|
if (isJustSent && existingConversation && !isLatestInMemory) {
|
|
// The message is being sent before the user has scrolled down to load the newest
|
|
// messages into memory; in that case, we scroll the user all the way down by
|
|
// loading the newest message
|
|
drop(this.loadNewestMessages(newestId, undefined));
|
|
} else if (
|
|
// The message has to be not a story or has to be a story reply in direct
|
|
// conversation.
|
|
!isStory(message.attributes) &&
|
|
(message.get('storyId') == null || isDirectConversation(this.attributes))
|
|
) {
|
|
messagesAdded({
|
|
conversationId,
|
|
messages: [{ ...message.attributes }],
|
|
isActive: window.SignalContext.activeWindowService.isActive(),
|
|
isJustSent,
|
|
isNewMessage: true,
|
|
});
|
|
}
|
|
}
|
|
|
|
private setInProgressFetch(): () => unknown {
|
|
const logId = `setInProgressFetch(${this.idForLogging()})`;
|
|
const start = Date.now();
|
|
|
|
let resolvePromise: (value?: unknown) => void;
|
|
this.inProgressFetch = new Promise(resolve => {
|
|
resolvePromise = resolve;
|
|
});
|
|
|
|
let timeout: NodeJS.Timeout;
|
|
const finish = () => {
|
|
const duration = Date.now() - start;
|
|
if (duration > 500) {
|
|
log.warn(`${logId}: in progress fetch took ${duration}ms`);
|
|
}
|
|
|
|
resolvePromise();
|
|
clearTimeout(timeout);
|
|
this.inProgressFetch = undefined;
|
|
};
|
|
timeout = setTimeout(() => {
|
|
log.warn(`${logId}: Calling finish manually after timeout`);
|
|
finish();
|
|
}, FETCH_TIMEOUT);
|
|
|
|
return finish;
|
|
}
|
|
|
|
async loadNewestMessages(
|
|
newestMessageId: string | undefined,
|
|
setFocus: boolean | undefined
|
|
): Promise<void> {
|
|
const logId = `loadNewestMessages/${this.idForLogging()}`;
|
|
|
|
const { messagesReset, setMessageLoadingState } =
|
|
window.reduxActions.conversations;
|
|
const conversationId = this.id;
|
|
|
|
setMessageLoadingState(
|
|
conversationId,
|
|
TimelineMessageLoadingState.DoingInitialLoad
|
|
);
|
|
const finish = this.setInProgressFetch();
|
|
|
|
try {
|
|
let scrollToLatestUnread = true;
|
|
|
|
if (newestMessageId) {
|
|
const newestInMemoryMessage = await getMessageById(newestMessageId);
|
|
if (newestInMemoryMessage) {
|
|
// If newest in-memory message is unread, scrolling down would mean going to
|
|
// the very bottom, not the oldest unread.
|
|
if (isMessageUnread(newestInMemoryMessage)) {
|
|
scrollToLatestUnread = false;
|
|
}
|
|
} else {
|
|
log.warn(
|
|
`loadNewestMessages: did not find message ${newestMessageId}`
|
|
);
|
|
}
|
|
}
|
|
|
|
const metrics = await getMessageMetricsForConversation({
|
|
conversationId,
|
|
includeStoryReplies: !isGroup(this.attributes),
|
|
});
|
|
|
|
// If this is a message request that has not yet been accepted, we always show the
|
|
// oldest messages, to ensure that the ConversationHero is shown. We don't want to
|
|
// scroll directly to the oldest message, because that could scroll the hero off
|
|
// the screen.
|
|
if (
|
|
!newestMessageId &&
|
|
!this.getAccepted() &&
|
|
this.get('removalStage') !== 'justNotification' &&
|
|
metrics.oldest
|
|
) {
|
|
log.info(`${logId}: scrolling to oldest ${metrics.oldest.sent_at}`);
|
|
void this.loadAndScroll(metrics.oldest.id, { disableScroll: true });
|
|
return;
|
|
}
|
|
|
|
if (scrollToLatestUnread && metrics.oldestUnseen) {
|
|
log.info(
|
|
`${logId}: scrolling to oldest unseen ${metrics.oldestUnseen.sent_at}`
|
|
);
|
|
void this.loadAndScroll(metrics.oldestUnseen.id, {
|
|
disableScroll: !setFocus,
|
|
});
|
|
return;
|
|
}
|
|
|
|
const messages = await getOlderMessagesByConversation({
|
|
conversationId,
|
|
includeStoryReplies: !isGroup(this.attributes),
|
|
limit: MESSAGE_LOAD_CHUNK_SIZE,
|
|
storyId: undefined,
|
|
});
|
|
|
|
const cleaned: Array<MessageModel> = await this.cleanModels(messages);
|
|
const scrollToMessageId =
|
|
setFocus && metrics.newest ? metrics.newest.id : undefined;
|
|
|
|
log.info(
|
|
`${logId}: loaded ${cleaned.length} messages, ` +
|
|
`latest timestamp=${cleaned.at(-1)?.get('sent_at')}`
|
|
);
|
|
|
|
// Because our `getOlderMessages` fetch above didn't specify a receivedAt, we got
|
|
// the most recent N messages in the conversation. If it has a conflict with
|
|
// metrics, fetched a bit before, that's likely a race condition. So we tell our
|
|
// reducer to trust the message set we just fetched for determining if we have
|
|
// the newest message loaded.
|
|
const unboundedFetch = true;
|
|
messagesReset({
|
|
conversationId,
|
|
messages: cleaned.map((messageModel: MessageModel) => ({
|
|
...messageModel.attributes,
|
|
})),
|
|
metrics,
|
|
scrollToMessageId,
|
|
unboundedFetch,
|
|
});
|
|
} catch (error) {
|
|
setMessageLoadingState(conversationId, undefined);
|
|
throw error;
|
|
} finally {
|
|
finish();
|
|
}
|
|
}
|
|
async loadOlderMessages(oldestMessageId: string): Promise<void> {
|
|
const logId = `loadOlderMessages/${this.idForLogging()}`;
|
|
|
|
const { messagesAdded, setMessageLoadingState, repairOldestMessage } =
|
|
window.reduxActions.conversations;
|
|
const conversationId = this.id;
|
|
|
|
setMessageLoadingState(
|
|
conversationId,
|
|
TimelineMessageLoadingState.LoadingOlderMessages
|
|
);
|
|
const finish = this.setInProgressFetch();
|
|
|
|
try {
|
|
const message = await getMessageById(oldestMessageId);
|
|
if (!message) {
|
|
throw new Error(`${logId}: failed to load message ${oldestMessageId}`);
|
|
}
|
|
|
|
const receivedAt = message.received_at;
|
|
const sentAt = message.sent_at;
|
|
const models = await getOlderMessagesByConversation({
|
|
conversationId,
|
|
includeStoryReplies: !isGroup(this.attributes),
|
|
limit: MESSAGE_LOAD_CHUNK_SIZE,
|
|
messageId: oldestMessageId,
|
|
receivedAt,
|
|
sentAt,
|
|
storyId: undefined,
|
|
});
|
|
|
|
if (models.length < 1) {
|
|
log.warn(`${logId}: requested, but loaded no messages`);
|
|
repairOldestMessage(conversationId);
|
|
return;
|
|
}
|
|
|
|
const cleaned = await this.cleanModels(models);
|
|
|
|
log.info(
|
|
`${logId}: loaded ${cleaned.length} messages, ` +
|
|
`first timestamp=${cleaned.at(0)?.get('sent_at')}`
|
|
);
|
|
|
|
messagesAdded({
|
|
conversationId,
|
|
messages: cleaned.map((messageModel: MessageModel) => ({
|
|
...messageModel.attributes,
|
|
})),
|
|
isActive: window.SignalContext.activeWindowService.isActive(),
|
|
isJustSent: false,
|
|
isNewMessage: false,
|
|
});
|
|
} catch (error) {
|
|
setMessageLoadingState(conversationId, undefined);
|
|
throw error;
|
|
} finally {
|
|
finish();
|
|
}
|
|
}
|
|
|
|
async loadNewerMessages(newestMessageId: string): Promise<void> {
|
|
const { messagesAdded, setMessageLoadingState, repairNewestMessage } =
|
|
window.reduxActions.conversations;
|
|
const conversationId = this.id;
|
|
|
|
setMessageLoadingState(
|
|
conversationId,
|
|
TimelineMessageLoadingState.LoadingNewerMessages
|
|
);
|
|
const finish = this.setInProgressFetch();
|
|
|
|
try {
|
|
const message = await getMessageById(newestMessageId);
|
|
if (!message) {
|
|
throw new Error(
|
|
`loadNewerMessages: failed to load message ${newestMessageId}`
|
|
);
|
|
}
|
|
|
|
const receivedAt = message.received_at;
|
|
const sentAt = message.sent_at;
|
|
const models = await getNewerMessagesByConversation({
|
|
conversationId,
|
|
includeStoryReplies: !isGroup(this.attributes),
|
|
limit: MESSAGE_LOAD_CHUNK_SIZE,
|
|
receivedAt,
|
|
sentAt,
|
|
storyId: undefined,
|
|
});
|
|
|
|
if (models.length < 1) {
|
|
log.warn('loadNewerMessages: requested, but loaded no messages');
|
|
repairNewestMessage(conversationId);
|
|
return;
|
|
}
|
|
|
|
const cleaned = await this.cleanModels(models);
|
|
messagesAdded({
|
|
conversationId,
|
|
messages: cleaned.map((messageModel: MessageModel) => ({
|
|
...messageModel.attributes,
|
|
})),
|
|
isActive: window.SignalContext.activeWindowService.isActive(),
|
|
isJustSent: false,
|
|
isNewMessage: false,
|
|
});
|
|
} catch (error) {
|
|
setMessageLoadingState(conversationId, undefined);
|
|
throw error;
|
|
} finally {
|
|
finish();
|
|
}
|
|
}
|
|
|
|
async loadAndScroll(
|
|
messageId: string,
|
|
options?: { disableScroll?: boolean }
|
|
): Promise<void> {
|
|
const { messagesReset, setMessageLoadingState } =
|
|
window.reduxActions.conversations;
|
|
const conversationId = this.id;
|
|
|
|
setMessageLoadingState(
|
|
conversationId,
|
|
TimelineMessageLoadingState.DoingInitialLoad
|
|
);
|
|
const finish = this.setInProgressFetch();
|
|
|
|
try {
|
|
const message = await getMessageById(messageId);
|
|
if (!message) {
|
|
throw new Error(
|
|
`loadMoreAndScroll: failed to load message ${messageId}`
|
|
);
|
|
}
|
|
|
|
const receivedAt = message.received_at;
|
|
const sentAt = message.sent_at;
|
|
const { older, newer, metrics } =
|
|
await getConversationRangeCenteredOnMessage({
|
|
conversationId,
|
|
includeStoryReplies: !isGroup(this.attributes),
|
|
limit: MESSAGE_LOAD_CHUNK_SIZE,
|
|
messageId,
|
|
receivedAt,
|
|
sentAt,
|
|
storyId: undefined,
|
|
});
|
|
const all = [...older, message, ...newer];
|
|
|
|
const cleaned: Array<MessageModel> = await this.cleanModels(all);
|
|
const scrollToMessageId =
|
|
options && options.disableScroll ? undefined : messageId;
|
|
|
|
messagesReset({
|
|
conversationId,
|
|
messages: cleaned.map((messageModel: MessageModel) => ({
|
|
...messageModel.attributes,
|
|
})),
|
|
metrics,
|
|
scrollToMessageId,
|
|
});
|
|
} catch (error) {
|
|
setMessageLoadingState(conversationId, undefined);
|
|
throw error;
|
|
} finally {
|
|
finish();
|
|
}
|
|
}
|
|
|
|
async cleanModels(
|
|
messages: ReadonlyArray<MessageAttributesType>
|
|
): Promise<Array<MessageModel>> {
|
|
const result = messages
|
|
.filter(message => Boolean(message.id))
|
|
.map(message =>
|
|
window.MessageCache.__DEPRECATED$register(
|
|
message.id,
|
|
message,
|
|
'cleanModels'
|
|
)
|
|
);
|
|
|
|
const eliminated = messages.length - result.length;
|
|
if (eliminated > 0) {
|
|
log.warn(`cleanModels: Eliminated ${eliminated} messages without an id`);
|
|
}
|
|
const ourAci = window.textsecure.storage.user.getCheckedAci();
|
|
|
|
let upgraded = 0;
|
|
for (let max = result.length, i = 0; i < max; i += 1) {
|
|
const message = result[i];
|
|
const { attributes } = message;
|
|
const { schemaVersion } = attributes;
|
|
|
|
if ((schemaVersion || 0) < Message.VERSION_NEEDED_FOR_DISPLAY) {
|
|
// Yep, we really do want to wait for each of these
|
|
// eslint-disable-next-line no-await-in-loop
|
|
const upgradedMessage = await upgradeMessageSchema(attributes);
|
|
message.set(upgradedMessage);
|
|
// eslint-disable-next-line no-await-in-loop
|
|
await window.Signal.Data.saveMessage(upgradedMessage, { ourAci });
|
|
upgraded += 1;
|
|
}
|
|
}
|
|
if (upgraded > 0) {
|
|
log.warn(`cleanModels: Upgraded schema of ${upgraded} messages`);
|
|
}
|
|
|
|
await Promise.all(
|
|
result.map(model =>
|
|
model.hydrateStoryContext(undefined, { shouldSave: true })
|
|
)
|
|
);
|
|
|
|
return result;
|
|
}
|
|
|
|
format(): ConversationType {
|
|
if (this.cachedProps) {
|
|
return this.cachedProps;
|
|
}
|
|
|
|
const oldFormat = this.format;
|
|
// We don't want to crash or have an infinite loop if we loop back into this function
|
|
// again. We'll log a warning and returned old cached props or throw an error.
|
|
this.format = () => {
|
|
if (!this.oldCachedProps) {
|
|
throw new Error(
|
|
`Conversation.format()/${this.idForLogging()} reentrant call, no old cached props!`
|
|
);
|
|
}
|
|
|
|
const { stack } = new Error('for stack');
|
|
log.warn(
|
|
`Conversation.format()/${this.idForLogging()} reentrant call! ${stack}`
|
|
);
|
|
|
|
return this.oldCachedProps;
|
|
};
|
|
|
|
try {
|
|
const { oldCachedProps } = this;
|
|
const newCachedProps = getConversation(this);
|
|
|
|
if (oldCachedProps && isShallowEqual(oldCachedProps, newCachedProps)) {
|
|
this.cachedProps = oldCachedProps;
|
|
} else {
|
|
this.cachedProps = newCachedProps;
|
|
}
|
|
|
|
return this.cachedProps;
|
|
} finally {
|
|
this.format = oldFormat;
|
|
}
|
|
}
|
|
|
|
updateE164(e164?: string | null): void {
|
|
const oldValue = this.get('e164');
|
|
if (e164 === oldValue) {
|
|
return;
|
|
}
|
|
|
|
this.set('e164', e164 || undefined);
|
|
|
|
// This user changed their phone number
|
|
if (oldValue && e164 && this.get('sharingPhoneNumber')) {
|
|
void this.addChangeNumberNotification(oldValue, e164);
|
|
}
|
|
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
this.trigger('idUpdated', this, 'e164', oldValue);
|
|
this.captureChange('updateE164');
|
|
}
|
|
|
|
updateServiceId(serviceId?: ServiceIdString): void {
|
|
const oldValue = this.getServiceId();
|
|
if (serviceId === oldValue) {
|
|
return;
|
|
}
|
|
|
|
this.set(
|
|
'serviceId',
|
|
serviceId
|
|
? normalizeServiceId(serviceId, 'Conversation.updateServiceId')
|
|
: undefined
|
|
);
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
this.trigger('idUpdated', this, 'serviceId', oldValue);
|
|
|
|
// We should delete the old sessions and identity information in all situations except
|
|
// for the case where we need to do old and new PNI comparisons. We'll wait
|
|
// for the PNI update to do that.
|
|
if (oldValue && oldValue !== this.getPni()) {
|
|
drop(window.textsecure.storage.protocol.removeIdentityKey(oldValue));
|
|
}
|
|
|
|
this.captureChange('updateServiceId');
|
|
}
|
|
|
|
trackPreviousIdentityKey(publicKey: Uint8Array): void {
|
|
const logId = `trackPreviousIdentityKey/${this.idForLogging()}`;
|
|
const identityKey = Bytes.toBase64(publicKey);
|
|
|
|
if (!isDirectConversation(this.attributes)) {
|
|
throw new Error(`${logId}: Called for non-private conversation`);
|
|
}
|
|
|
|
const existingIdentityKey = this.get('previousIdentityKey');
|
|
if (existingIdentityKey && existingIdentityKey !== identityKey) {
|
|
log.warn(
|
|
`${logId}: Already had previousIdentityKey, new one does not match`
|
|
);
|
|
void this.addKeyChange('trackPreviousIdentityKey - change');
|
|
}
|
|
|
|
log.warn(`${logId}: Setting new previousIdentityKey`);
|
|
this.set({
|
|
previousIdentityKey: identityKey,
|
|
});
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
}
|
|
|
|
updatePni(pni: PniString | undefined, pniSignatureVerified: boolean): void {
|
|
const oldValue = this.getPni();
|
|
if (pni === oldValue) {
|
|
return;
|
|
}
|
|
|
|
this.set(
|
|
'pni',
|
|
pni ? normalizePni(pni, 'Conversation.updatePni') : undefined
|
|
);
|
|
const newPniSignatureVerified = pni ? pniSignatureVerified : false;
|
|
if (this.get('pniSignatureVerified') !== newPniSignatureVerified) {
|
|
log.warn(
|
|
`updatePni/${this.idForLogging()}: setting ` +
|
|
`pniSignatureVerified to ${newPniSignatureVerified}`
|
|
);
|
|
this.set('pniSignatureVerified', newPniSignatureVerified);
|
|
this.captureChange('pniSignatureVerified');
|
|
}
|
|
|
|
const pniIsPrimaryId =
|
|
!this.getServiceId() ||
|
|
this.getServiceId() === oldValue ||
|
|
this.getServiceId() === pni;
|
|
const haveSentMessage = Boolean(
|
|
this.get('profileSharing') || this.get('sentMessageCount')
|
|
);
|
|
|
|
if (oldValue && pniIsPrimaryId && haveSentMessage) {
|
|
// We're going from an old PNI to a new PNI
|
|
if (pni) {
|
|
const oldIdentityRecord =
|
|
window.textsecure.storage.protocol.getIdentityRecord(oldValue);
|
|
const newIdentityRecord =
|
|
window.textsecure.storage.protocol.getIdentityRecord(pni);
|
|
|
|
if (
|
|
newIdentityRecord &&
|
|
oldIdentityRecord &&
|
|
!constantTimeEqual(
|
|
oldIdentityRecord.publicKey,
|
|
newIdentityRecord.publicKey
|
|
)
|
|
) {
|
|
void this.addKeyChange('updatePni - change');
|
|
} else if (!newIdentityRecord && oldIdentityRecord) {
|
|
this.trackPreviousIdentityKey(oldIdentityRecord.publicKey);
|
|
}
|
|
}
|
|
|
|
// We're just dropping the PNI
|
|
if (!pni) {
|
|
const oldIdentityRecord =
|
|
window.textsecure.storage.protocol.getIdentityRecord(oldValue);
|
|
|
|
if (oldIdentityRecord) {
|
|
this.trackPreviousIdentityKey(oldIdentityRecord.publicKey);
|
|
}
|
|
}
|
|
}
|
|
|
|
// If this PNI is going away or going to someone else, we'll delete all its sessions
|
|
if (oldValue) {
|
|
drop(window.textsecure.storage.protocol.removeIdentityKey(oldValue));
|
|
}
|
|
|
|
if (pni && !this.getServiceId()) {
|
|
log.warn(
|
|
`updatePni/${this.idForLogging()}: pni field set to ${pni}, but service id field is empty!`
|
|
);
|
|
}
|
|
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
this.trigger('idUpdated', this, 'pni', oldValue);
|
|
this.captureChange('updatePni');
|
|
}
|
|
|
|
updateGroupId(groupId?: string): void {
|
|
const oldValue = this.get('groupId');
|
|
if (groupId && groupId !== oldValue) {
|
|
this.set('groupId', groupId);
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
this.trigger('idUpdated', this, 'groupId', oldValue);
|
|
}
|
|
}
|
|
|
|
async updateReportingToken(token?: Uint8Array): Promise<void> {
|
|
const oldValue = this.get('reportingToken');
|
|
const newValue = token ? Bytes.toBase64(token) : undefined;
|
|
|
|
if (oldValue === newValue) {
|
|
return;
|
|
}
|
|
|
|
this.set('reportingToken', newValue);
|
|
await window.Signal.Data.updateConversation(this.attributes);
|
|
}
|
|
|
|
incrementMessageCount(): void {
|
|
this.set({
|
|
messageCount: (this.get('messageCount') || 0) + 1,
|
|
});
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
}
|
|
|
|
incrementSentMessageCount({ dry = false }: { dry?: boolean } = {}):
|
|
| Partial<ConversationAttributesType>
|
|
| undefined {
|
|
const needsTitleTransition =
|
|
hasNumberTitle(this.attributes) || hasUsernameTitle(this.attributes);
|
|
const update = {
|
|
messageCount: (this.get('messageCount') || 0) + 1,
|
|
sentMessageCount: (this.get('sentMessageCount') || 0) + 1,
|
|
...(needsTitleTransition ? { needsTitleTransition: true } : {}),
|
|
};
|
|
|
|
if (dry) {
|
|
return update;
|
|
}
|
|
this.set(update);
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
|
|
return undefined;
|
|
}
|
|
|
|
/**
|
|
* This function is called when a message request is accepted in order to
|
|
* handle sending read receipts and download any pending attachments.
|
|
*/
|
|
async handleReadAndDownloadAttachments(
|
|
options: { isLocalAction?: boolean } = {}
|
|
): Promise<void> {
|
|
const { isLocalAction } = options;
|
|
const ourAci = window.textsecure.storage.user.getCheckedAci();
|
|
|
|
let messages: Array<MessageAttributesType> | undefined;
|
|
do {
|
|
const first = messages ? messages[0] : undefined;
|
|
|
|
// eslint-disable-next-line no-await-in-loop
|
|
messages = await window.Signal.Data.getOlderMessagesByConversation({
|
|
conversationId: this.get('id'),
|
|
includeStoryReplies: !isGroup(this.attributes),
|
|
limit: 100,
|
|
messageId: first ? first.id : undefined,
|
|
receivedAt: first ? first.received_at : undefined,
|
|
sentAt: first ? first.sent_at : undefined,
|
|
storyId: undefined,
|
|
});
|
|
|
|
if (!messages.length) {
|
|
return;
|
|
}
|
|
|
|
const readMessages = messages.filter(m => !hasErrors(m) && isIncoming(m));
|
|
|
|
if (isLocalAction) {
|
|
const conversationId = this.get('id');
|
|
|
|
// eslint-disable-next-line no-await-in-loop
|
|
await conversationJobQueue.add({
|
|
type: conversationQueueJobEnum.enum.Receipts,
|
|
conversationId: this.get('id'),
|
|
receiptsType: ReceiptType.Read,
|
|
receipts: readMessages.map(m => {
|
|
const { sourceServiceId: senderAci } = m;
|
|
strictAssert(isAciString(senderAci), "Can't send receipt to PNI");
|
|
|
|
return {
|
|
messageId: m.id,
|
|
conversationId,
|
|
senderE164: m.source,
|
|
senderAci,
|
|
timestamp: getMessageSentTimestamp(m, { log }),
|
|
isDirectConversation: isDirectConversation(this.attributes),
|
|
};
|
|
}),
|
|
});
|
|
}
|
|
|
|
// eslint-disable-next-line no-await-in-loop
|
|
await Promise.all(
|
|
readMessages.map(async m => {
|
|
const registered = window.MessageCache.__DEPRECATED$register(
|
|
m.id,
|
|
m,
|
|
'handleReadAndDownloadAttachments'
|
|
);
|
|
const shouldSave = await registered.queueAttachmentDownloads();
|
|
if (shouldSave) {
|
|
await window.Signal.Data.saveMessage(registered.attributes, {
|
|
ourAci,
|
|
});
|
|
}
|
|
})
|
|
);
|
|
} while (messages.length > 0);
|
|
}
|
|
|
|
async addMessageRequestResponseEventMessage(
|
|
event: MessageRequestResponseEvent
|
|
): Promise<void> {
|
|
const timestamp = Date.now();
|
|
const lastMessageTimestamp =
|
|
// Fallback to `timestamp` since `lastMessageReceivedAtMs` is new
|
|
this.get('lastMessageReceivedAtMs') ?? this.get('timestamp') ?? timestamp;
|
|
|
|
const maybeLastMessageTimestamp =
|
|
event === MessageRequestResponseEvent.ACCEPT
|
|
? timestamp
|
|
: lastMessageTimestamp;
|
|
|
|
const message: MessageAttributesType = {
|
|
id: generateGuid(),
|
|
conversationId: this.id,
|
|
type: 'message-request-response-event',
|
|
sent_at: maybeLastMessageTimestamp,
|
|
received_at: incrementMessageCounter(),
|
|
received_at_ms: maybeLastMessageTimestamp,
|
|
readStatus: ReadStatus.Read,
|
|
seenStatus: SeenStatus.NotApplicable,
|
|
timestamp,
|
|
messageRequestResponseEvent: event,
|
|
};
|
|
|
|
const id = await window.Signal.Data.saveMessage(message, {
|
|
ourAci: window.textsecure.storage.user.getCheckedAci(),
|
|
forceSave: true,
|
|
});
|
|
const model = new window.Whisper.Message({
|
|
...message,
|
|
id,
|
|
});
|
|
window.MessageCache.toMessageAttributes(model.attributes);
|
|
this.trigger('newmessage', model);
|
|
drop(this.updateLastMessage());
|
|
}
|
|
|
|
async applyMessageRequestResponse(
|
|
response: Proto.SyncMessage.MessageRequestResponse.Type,
|
|
{ fromSync = false, viaStorageServiceSync = false, shouldSave = true } = {}
|
|
): Promise<void> {
|
|
try {
|
|
const messageRequestEnum = Proto.SyncMessage.MessageRequestResponse.Type;
|
|
const isLocalAction = !fromSync && !viaStorageServiceSync;
|
|
|
|
const currentMessageRequestState = this.get('messageRequestResponseType');
|
|
const didResponseChange = response !== currentMessageRequestState;
|
|
const wasPreviouslyAccepted = this.getAccepted();
|
|
|
|
const didUnblock =
|
|
response === messageRequestEnum.ACCEPT && this.isBlocked();
|
|
|
|
if (didResponseChange) {
|
|
if (response === messageRequestEnum.ACCEPT) {
|
|
// Only add a message when the user took an explicit action to accept
|
|
// the message request on one of their devices
|
|
if (!viaStorageServiceSync) {
|
|
drop(
|
|
this.addMessageRequestResponseEventMessage(
|
|
didUnblock
|
|
? MessageRequestResponseEvent.UNBLOCK
|
|
: MessageRequestResponseEvent.ACCEPT
|
|
)
|
|
);
|
|
}
|
|
}
|
|
if (
|
|
response === messageRequestEnum.BLOCK ||
|
|
response === messageRequestEnum.BLOCK_AND_SPAM ||
|
|
response === messageRequestEnum.BLOCK_AND_DELETE
|
|
) {
|
|
drop(
|
|
this.addMessageRequestResponseEventMessage(
|
|
MessageRequestResponseEvent.BLOCK
|
|
)
|
|
);
|
|
}
|
|
if (
|
|
response === messageRequestEnum.SPAM ||
|
|
response === messageRequestEnum.BLOCK_AND_SPAM
|
|
) {
|
|
drop(
|
|
this.addMessageRequestResponseEventMessage(
|
|
MessageRequestResponseEvent.SPAM
|
|
)
|
|
);
|
|
}
|
|
}
|
|
|
|
// Apply message request response locally
|
|
this.set({
|
|
messageRequestResponseType: response,
|
|
});
|
|
|
|
const rejectConversation = async ({
|
|
isBlock = false,
|
|
isDelete = false,
|
|
isSpam = false,
|
|
}: {
|
|
isBlock?: boolean;
|
|
isDelete?: boolean;
|
|
isSpam?: boolean;
|
|
}) => {
|
|
if (isBlock) {
|
|
this.block({ viaStorageServiceSync });
|
|
}
|
|
|
|
if (isBlock || isDelete) {
|
|
this.disableProfileSharing({ viaStorageServiceSync });
|
|
}
|
|
|
|
if (isDelete) {
|
|
await this.destroyMessages();
|
|
void this.updateLastMessage();
|
|
}
|
|
|
|
if (isBlock || isDelete) {
|
|
if (isLocalAction) {
|
|
window.reduxActions.conversations.onConversationClosed(
|
|
this.id,
|
|
isBlock
|
|
? 'blocked from message request'
|
|
: 'deleted from message request'
|
|
);
|
|
|
|
if (isGroupV2(this.attributes)) {
|
|
await this.leaveGroupV2();
|
|
}
|
|
}
|
|
}
|
|
|
|
if (isSpam) {
|
|
this.set({ isReported: true });
|
|
}
|
|
};
|
|
|
|
if (response === messageRequestEnum.ACCEPT) {
|
|
this.unblock({ viaStorageServiceSync });
|
|
if (!viaStorageServiceSync) {
|
|
await this.restoreContact({ shouldSave: false });
|
|
}
|
|
this.enableProfileSharing({ viaStorageServiceSync });
|
|
|
|
// We really don't want to call this if we don't have to. It can take a lot of
|
|
// time to go through old messages to download attachments.
|
|
if (didResponseChange && !wasPreviouslyAccepted) {
|
|
await this.handleReadAndDownloadAttachments({ isLocalAction });
|
|
}
|
|
|
|
if (isLocalAction) {
|
|
const ourAci = window.textsecure.storage.user.getCheckedAci();
|
|
const ourPni = window.textsecure.storage.user.getPni();
|
|
const ourConversation =
|
|
window.ConversationController.getOurConversationOrThrow();
|
|
|
|
if (
|
|
isGroupV1(this.attributes) ||
|
|
isDirectConversation(this.attributes)
|
|
) {
|
|
void this.sendProfileKeyUpdate();
|
|
} else if (
|
|
isGroupV2(this.attributes) &&
|
|
this.isMemberPending(ourAci)
|
|
) {
|
|
await this.modifyGroupV2({
|
|
name: 'promotePendingMember',
|
|
usingCredentialsFrom: [ourConversation],
|
|
createGroupChange: () =>
|
|
this.promotePendingMember(ServiceIdKind.ACI),
|
|
});
|
|
} else if (
|
|
ourPni &&
|
|
isGroupV2(this.attributes) &&
|
|
this.isMemberPending(ourPni)
|
|
) {
|
|
await this.modifyGroupV2({
|
|
name: 'promotePendingMember',
|
|
usingCredentialsFrom: [ourConversation],
|
|
createGroupChange: () =>
|
|
this.promotePendingMember(ServiceIdKind.PNI),
|
|
});
|
|
} else if (isGroupV2(this.attributes) && this.isMember(ourAci)) {
|
|
log.info(
|
|
'applyMessageRequestResponse/accept: Already a member of v2 group'
|
|
);
|
|
} else {
|
|
log.error(
|
|
'applyMessageRequestResponse/accept: Neither member nor pending member of v2 group'
|
|
);
|
|
}
|
|
}
|
|
} else if (response === messageRequestEnum.BLOCK) {
|
|
await rejectConversation({ isBlock: true });
|
|
} else if (response === messageRequestEnum.DELETE) {
|
|
await rejectConversation({ isDelete: true });
|
|
} else if (response === messageRequestEnum.BLOCK_AND_DELETE) {
|
|
await rejectConversation({ isBlock: true, isDelete: true });
|
|
} else if (response === messageRequestEnum.SPAM) {
|
|
await rejectConversation({ isSpam: true });
|
|
} else if (response === messageRequestEnum.BLOCK_AND_SPAM) {
|
|
await rejectConversation({ isBlock: true, isSpam: true });
|
|
}
|
|
} finally {
|
|
if (shouldSave) {
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
}
|
|
}
|
|
}
|
|
|
|
async joinGroupV2ViaLinkAndMigrate({
|
|
approvalRequired,
|
|
inviteLinkPassword,
|
|
revision,
|
|
}: {
|
|
approvalRequired: boolean;
|
|
inviteLinkPassword: string;
|
|
revision: number;
|
|
}): Promise<void> {
|
|
await window.Signal.Groups.joinGroupV2ViaLinkAndMigrate({
|
|
approvalRequired,
|
|
conversation: this,
|
|
inviteLinkPassword,
|
|
revision,
|
|
});
|
|
}
|
|
|
|
async joinGroupV2ViaLink({
|
|
inviteLinkPassword,
|
|
approvalRequired,
|
|
}: {
|
|
inviteLinkPassword: string;
|
|
approvalRequired: boolean;
|
|
}): Promise<void> {
|
|
const ourAci = window.textsecure.storage.user.getCheckedAci();
|
|
const ourConversation =
|
|
window.ConversationController.getOurConversationOrThrow();
|
|
try {
|
|
if (approvalRequired) {
|
|
await this.modifyGroupV2({
|
|
name: 'requestToJoin',
|
|
usingCredentialsFrom: [ourConversation],
|
|
inviteLinkPassword,
|
|
createGroupChange: () => this.addPendingApprovalRequest(),
|
|
});
|
|
} else {
|
|
await this.modifyGroupV2({
|
|
name: 'joinGroup',
|
|
usingCredentialsFrom: [ourConversation],
|
|
inviteLinkPassword,
|
|
createGroupChange: () => this.addMember(ourAci),
|
|
});
|
|
}
|
|
} catch (error) {
|
|
const ALREADY_REQUESTED_TO_JOIN =
|
|
'{"code":400,"message":"cannot ask to join via invite link if already asked to join"}';
|
|
if (!error.response) {
|
|
throw error;
|
|
} else {
|
|
const errorDetails = Bytes.toString(error.response);
|
|
if (errorDetails !== ALREADY_REQUESTED_TO_JOIN) {
|
|
throw error;
|
|
} else {
|
|
log.info(
|
|
'joinGroupV2ViaLink: Got 400, but server is telling us we have already requested to join. Forcing that local state'
|
|
);
|
|
this.set({
|
|
pendingAdminApprovalV2: [
|
|
{
|
|
aci: ourAci,
|
|
timestamp: Date.now(),
|
|
},
|
|
],
|
|
});
|
|
}
|
|
}
|
|
}
|
|
|
|
const messageRequestEnum = Proto.SyncMessage.MessageRequestResponse.Type;
|
|
|
|
// Ensure active_at is set, because this is an event that justifies putting the group
|
|
// in the left pane.
|
|
this.set({
|
|
messageRequestResponseType: messageRequestEnum.ACCEPT,
|
|
active_at: this.get('active_at') || Date.now(),
|
|
});
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
}
|
|
|
|
async cancelJoinRequest(): Promise<void> {
|
|
const ourAci = window.storage.user.getCheckedAci();
|
|
|
|
const inviteLinkPassword = this.get('groupInviteLinkPassword');
|
|
if (!inviteLinkPassword) {
|
|
log.warn(
|
|
`cancelJoinRequest/${this.idForLogging()}: We don't have an inviteLinkPassword!`
|
|
);
|
|
}
|
|
|
|
await this.modifyGroupV2({
|
|
name: 'cancelJoinRequest',
|
|
usingCredentialsFrom: [],
|
|
inviteLinkPassword,
|
|
createGroupChange: () => this.denyPendingApprovalRequest(ourAci),
|
|
});
|
|
}
|
|
|
|
async leaveGroupV2(): Promise<void> {
|
|
if (!isGroupV2(this.attributes)) {
|
|
return;
|
|
}
|
|
|
|
const ourAci = window.textsecure.storage.user.getCheckedAci();
|
|
const ourPni = window.textsecure.storage.user.getPni();
|
|
const ourConversation =
|
|
window.ConversationController.getOurConversationOrThrow();
|
|
|
|
if (this.isMemberPending(ourAci)) {
|
|
await this.modifyGroupV2({
|
|
name: 'delete',
|
|
usingCredentialsFrom: [],
|
|
createGroupChange: () => this.removePendingMember([ourAci]),
|
|
});
|
|
} else if (this.isMember(ourAci)) {
|
|
await this.modifyGroupV2({
|
|
name: 'delete',
|
|
usingCredentialsFrom: [ourConversation],
|
|
createGroupChange: () => this.removeMember(ourAci),
|
|
});
|
|
// Keep PNI in pending if ACI was a member.
|
|
} else if (ourPni && this.isMemberPending(ourPni)) {
|
|
await this.modifyGroupV2({
|
|
name: 'delete',
|
|
usingCredentialsFrom: [],
|
|
createGroupChange: () => this.removePendingMember([ourPni]),
|
|
syncMessageOnly: true,
|
|
});
|
|
} else {
|
|
const logId = this.idForLogging();
|
|
log.error(
|
|
'leaveGroupV2: We were neither a member nor a pending member of ' +
|
|
`the group ${logId}`
|
|
);
|
|
}
|
|
}
|
|
|
|
async addBannedMember(
|
|
serviceId: ServiceIdString
|
|
): Promise<Proto.GroupChange.Actions | undefined> {
|
|
if (this.isMember(serviceId)) {
|
|
log.warn('addBannedMember: Member is a part of the group!');
|
|
|
|
return;
|
|
}
|
|
|
|
if (this.isMemberPending(serviceId)) {
|
|
log.warn('addBannedMember: Member is pending to be added to group!');
|
|
|
|
return;
|
|
}
|
|
|
|
if (isMemberBanned(this.attributes, serviceId)) {
|
|
log.warn('addBannedMember: Member is already banned!');
|
|
|
|
return;
|
|
}
|
|
|
|
return window.Signal.Groups.buildAddBannedMemberChange({
|
|
group: this.attributes,
|
|
serviceId,
|
|
});
|
|
}
|
|
|
|
async blockGroupLinkRequests(serviceId: ServiceIdString): Promise<void> {
|
|
await this.modifyGroupV2({
|
|
name: 'addBannedMember',
|
|
usingCredentialsFrom: [],
|
|
createGroupChange: async () => this.addBannedMember(serviceId),
|
|
});
|
|
}
|
|
|
|
async toggleAdmin(conversationId: string): Promise<void> {
|
|
if (!isGroupV2(this.attributes)) {
|
|
return;
|
|
}
|
|
|
|
const logId = this.idForLogging();
|
|
|
|
const member = window.ConversationController.get(conversationId);
|
|
if (!member) {
|
|
log.error(`toggleAdmin/${logId}: ${conversationId} does not exist`);
|
|
return;
|
|
}
|
|
|
|
const serviceId = member.getCheckedServiceId(`toggleAdmin/${logId}`);
|
|
|
|
if (!this.isMember(serviceId)) {
|
|
log.error(
|
|
`toggleAdmin: Member ${conversationId} is not a member of the group`
|
|
);
|
|
return;
|
|
}
|
|
|
|
await this.modifyGroupV2({
|
|
name: 'toggleAdmin',
|
|
usingCredentialsFrom: [member],
|
|
createGroupChange: () => this.toggleAdminChange(serviceId),
|
|
});
|
|
}
|
|
|
|
async removeFromGroupV2(conversationId: string): Promise<void> {
|
|
if (!isGroupV2(this.attributes)) {
|
|
return;
|
|
}
|
|
|
|
const logId = this.idForLogging();
|
|
const pendingMember = window.ConversationController.get(conversationId);
|
|
if (!pendingMember) {
|
|
throw new Error(
|
|
`removeFromGroupV2/${logId}: No conversation found for conversation ${conversationId}`
|
|
);
|
|
}
|
|
|
|
const serviceId = pendingMember.getCheckedServiceId(
|
|
`removeFromGroupV2/${logId}`
|
|
);
|
|
|
|
if (this.isMemberRequestingToJoin(serviceId)) {
|
|
strictAssert(isAciString(serviceId), 'Requesting member is not ACI');
|
|
await this.modifyGroupV2({
|
|
name: 'denyPendingApprovalRequest',
|
|
usingCredentialsFrom: [],
|
|
createGroupChange: () => this.denyPendingApprovalRequest(serviceId),
|
|
extraConversationsForSend: [conversationId],
|
|
});
|
|
} else if (this.isMemberPending(serviceId)) {
|
|
await this.modifyGroupV2({
|
|
name: 'removePendingMember',
|
|
usingCredentialsFrom: [],
|
|
createGroupChange: () => this.removePendingMember([serviceId]),
|
|
extraConversationsForSend: [conversationId],
|
|
});
|
|
} else if (this.isMember(serviceId)) {
|
|
await this.modifyGroupV2({
|
|
name: 'removeFromGroup',
|
|
usingCredentialsFrom: [pendingMember],
|
|
createGroupChange: () => this.removeMember(serviceId),
|
|
extraConversationsForSend: [conversationId],
|
|
});
|
|
} else {
|
|
log.error(
|
|
`removeFromGroupV2: Member ${conversationId} is neither a member nor a pending member of the group`
|
|
);
|
|
}
|
|
}
|
|
|
|
async safeGetVerified(): Promise<number> {
|
|
const serviceId = this.getServiceId();
|
|
if (!serviceId) {
|
|
return this.verifiedEnum.DEFAULT;
|
|
}
|
|
|
|
try {
|
|
return await window.textsecure.storage.protocol.getVerified(serviceId);
|
|
} catch {
|
|
return this.verifiedEnum.DEFAULT;
|
|
}
|
|
}
|
|
|
|
async updateVerified(): Promise<void> {
|
|
if (isDirectConversation(this.attributes)) {
|
|
await this.initialPromise;
|
|
const verified = await this.safeGetVerified();
|
|
|
|
const oldVerified = this.get('verified');
|
|
if (oldVerified !== verified) {
|
|
this.set({ verified });
|
|
this.captureChange(`updateVerified from=${oldVerified} to=${verified}`);
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
}
|
|
|
|
return;
|
|
}
|
|
|
|
this.fetchContacts();
|
|
|
|
await Promise.all(
|
|
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
|
|
this.contactCollection!.map(async contact => {
|
|
if (!isMe(contact.attributes)) {
|
|
await contact.updateVerified();
|
|
}
|
|
})
|
|
);
|
|
}
|
|
|
|
setVerifiedDefault(): Promise<boolean> {
|
|
const { DEFAULT } = this.verifiedEnum;
|
|
return this.queueJob('setVerifiedDefault', () =>
|
|
this._setVerified(DEFAULT)
|
|
);
|
|
}
|
|
|
|
setVerified(): Promise<boolean> {
|
|
const { VERIFIED } = this.verifiedEnum;
|
|
return this.queueJob('setVerified', () => this._setVerified(VERIFIED));
|
|
}
|
|
|
|
setUnverified(): Promise<boolean> {
|
|
const { UNVERIFIED } = this.verifiedEnum;
|
|
return this.queueJob('setUnverified', () => this._setVerified(UNVERIFIED));
|
|
}
|
|
|
|
private async _setVerified(verified: number): Promise<boolean> {
|
|
const { VERIFIED, DEFAULT } = this.verifiedEnum;
|
|
|
|
if (!isDirectConversation(this.attributes)) {
|
|
throw new Error(
|
|
'You cannot verify a group conversation. ' +
|
|
'You must verify individual contacts.'
|
|
);
|
|
}
|
|
|
|
const aci = this.getAci();
|
|
const beginningVerified = this.get('verified') ?? DEFAULT;
|
|
const keyChange = false;
|
|
if (aci) {
|
|
if (verified === this.verifiedEnum.DEFAULT) {
|
|
await window.textsecure.storage.protocol.setVerified(aci, verified);
|
|
} else {
|
|
await window.textsecure.storage.protocol.setVerified(aci, verified, {
|
|
firstUse: false,
|
|
nonblockingApproval: true,
|
|
});
|
|
}
|
|
} else {
|
|
log.warn(`_setVerified(${this.id}): no aci to update protocol storage`);
|
|
}
|
|
|
|
this.set({ verified });
|
|
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
|
|
if (beginningVerified !== verified) {
|
|
this.captureChange(
|
|
`_setVerified from=${beginningVerified} to=${verified}`
|
|
);
|
|
}
|
|
|
|
const didVerifiedChange = beginningVerified !== verified;
|
|
const isExplicitUserAction = true;
|
|
if (
|
|
// The message came from an explicit verification in a client (not
|
|
// storage service sync)
|
|
(didVerifiedChange && isExplicitUserAction) ||
|
|
// Our local verification status is VERIFIED and it hasn't changed, but the key did
|
|
// change (Key1/VERIFIED -> Key2/VERIFIED), but we don't want to show DEFAULT ->
|
|
// DEFAULT or UNVERIFIED -> UNVERIFIED
|
|
(keyChange && verified === VERIFIED)
|
|
) {
|
|
await this.addVerifiedChange(this.id, verified === VERIFIED, {
|
|
local: isExplicitUserAction,
|
|
});
|
|
}
|
|
if (isExplicitUserAction && aci) {
|
|
await this.sendVerifySyncMessage(this.get('e164'), aci, verified);
|
|
}
|
|
|
|
return keyChange;
|
|
}
|
|
|
|
async sendVerifySyncMessage(
|
|
e164: string | undefined,
|
|
aci: AciString,
|
|
state: number
|
|
): Promise<CallbackResultType | void> {
|
|
if (window.ConversationController.areWePrimaryDevice()) {
|
|
log.warn(
|
|
'sendVerifySyncMessage: We are primary device; not sending sync'
|
|
);
|
|
return;
|
|
}
|
|
|
|
const key = await window.textsecure.storage.protocol.loadIdentityKey(aci);
|
|
if (!key) {
|
|
throw new Error(
|
|
`sendVerifySyncMessage: No identity key found for aci ${aci}`
|
|
);
|
|
}
|
|
|
|
try {
|
|
await singleProtoJobQueue.add(
|
|
MessageSender.getVerificationSync(e164, aci, state, key)
|
|
);
|
|
} catch (error) {
|
|
log.error(
|
|
'sendVerifySyncMessage: Failed to queue sync message',
|
|
Errors.toLogFormat(error)
|
|
);
|
|
}
|
|
}
|
|
|
|
isVerified(): boolean {
|
|
if (isDirectConversation(this.attributes)) {
|
|
return this.get('verified') === this.verifiedEnum.VERIFIED;
|
|
}
|
|
|
|
const contacts = this.contactCollection;
|
|
|
|
if (contacts == null || contacts.length === 0) {
|
|
return false;
|
|
}
|
|
|
|
if (contacts.length === 1 && isMe(contacts.first()?.attributes)) {
|
|
return false;
|
|
}
|
|
|
|
return contacts.every(contact => {
|
|
if (isMe(contact.attributes)) {
|
|
return true;
|
|
}
|
|
return contact.isVerified();
|
|
});
|
|
}
|
|
|
|
isUnverified(): boolean {
|
|
if (isDirectConversation(this.attributes)) {
|
|
const verified = this.get('verified');
|
|
return (
|
|
verified !== this.verifiedEnum.VERIFIED &&
|
|
verified !== this.verifiedEnum.DEFAULT
|
|
);
|
|
}
|
|
|
|
if (!this.contactCollection?.length) {
|
|
return true;
|
|
}
|
|
|
|
return this.contactCollection?.some(contact => {
|
|
if (isMe(contact.attributes)) {
|
|
return false;
|
|
}
|
|
return contact.isUnverified();
|
|
});
|
|
}
|
|
|
|
getUnverified(): Array<ConversationModel> {
|
|
if (isDirectConversation(this.attributes)) {
|
|
return this.isUnverified() ? [this] : [];
|
|
}
|
|
return (
|
|
this.contactCollection?.filter(contact => {
|
|
if (isMe(contact.attributes)) {
|
|
return false;
|
|
}
|
|
return contact.isUnverified();
|
|
}) || []
|
|
);
|
|
}
|
|
|
|
async setApproved(): Promise<void> {
|
|
if (!isDirectConversation(this.attributes)) {
|
|
throw new Error(
|
|
'You cannot set a group conversation as trusted. ' +
|
|
'You must set individual contacts as trusted.'
|
|
);
|
|
}
|
|
|
|
const serviceId = this.getServiceId();
|
|
if (!serviceId) {
|
|
log.warn(`setApproved(${this.id}): no serviceId, ignoring`);
|
|
return;
|
|
}
|
|
|
|
return this.queueJob('setApproved', async () => {
|
|
return window.textsecure.storage.protocol.setApproval(serviceId, true);
|
|
});
|
|
}
|
|
|
|
safeIsUntrusted(timestampThreshold?: number): boolean {
|
|
try {
|
|
const serviceId = this.getServiceId();
|
|
strictAssert(serviceId, `No serviceId for conversation: ${this.id}`);
|
|
return window.textsecure.storage.protocol.isUntrusted(
|
|
serviceId,
|
|
timestampThreshold
|
|
);
|
|
} catch (err) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
isUntrusted(timestampThreshold?: number): boolean {
|
|
if (isDirectConversation(this.attributes)) {
|
|
return this.safeIsUntrusted(timestampThreshold);
|
|
}
|
|
const { contactCollection } = this;
|
|
|
|
if (!contactCollection?.length) {
|
|
return false;
|
|
}
|
|
|
|
return contactCollection.some(contact => {
|
|
if (isMe(contact.attributes)) {
|
|
return false;
|
|
}
|
|
return contact.safeIsUntrusted(timestampThreshold);
|
|
});
|
|
}
|
|
|
|
getUntrusted(timestampThreshold?: number): Array<ConversationModel> {
|
|
if (isDirectConversation(this.attributes)) {
|
|
if (this.isUntrusted(timestampThreshold)) {
|
|
return [this];
|
|
}
|
|
return [];
|
|
}
|
|
|
|
return (
|
|
this.contactCollection?.filter(contact => {
|
|
if (isMe(contact.attributes)) {
|
|
return false;
|
|
}
|
|
return contact.isUntrusted(timestampThreshold);
|
|
}) || []
|
|
);
|
|
}
|
|
|
|
getSentMessageCount(): number {
|
|
return this.get('sentMessageCount') || 0;
|
|
}
|
|
|
|
getMessageRequestResponseType(): number {
|
|
return this.get('messageRequestResponseType') || 0;
|
|
}
|
|
|
|
getAboutText(): string | undefined {
|
|
return getAboutText(this.attributes);
|
|
}
|
|
|
|
/**
|
|
* Determine if this conversation should be considered "accepted" in terms
|
|
* of message requests
|
|
*/
|
|
getAccepted(options?: IsConversationAcceptedOptionsType): boolean {
|
|
return isConversationAccepted(this.attributes, options);
|
|
}
|
|
|
|
onMemberVerifiedChange(): void {
|
|
// If the verified state of a member changes, our aggregate state changes.
|
|
// We trigger both events to replicate the behavior of window.Backbone.Model.set()
|
|
this.trigger('change:verified', this);
|
|
this.trigger('change', this, { force: true });
|
|
}
|
|
|
|
async toggleVerified(): Promise<unknown> {
|
|
if (this.isVerified()) {
|
|
return this.setVerifiedDefault();
|
|
}
|
|
return this.setVerified();
|
|
}
|
|
|
|
async addChatSessionRefreshed({
|
|
receivedAt,
|
|
receivedAtCounter,
|
|
}: {
|
|
receivedAt: number;
|
|
receivedAtCounter: number;
|
|
}): Promise<void> {
|
|
log.info(`addChatSessionRefreshed: adding for ${this.idForLogging()}`, {
|
|
receivedAt,
|
|
});
|
|
|
|
const message = {
|
|
conversationId: this.id,
|
|
type: 'chat-session-refreshed',
|
|
sent_at: receivedAt,
|
|
received_at: receivedAtCounter,
|
|
received_at_ms: receivedAt,
|
|
readStatus: ReadStatus.Unread,
|
|
seenStatus: SeenStatus.Unseen,
|
|
// TODO: DESKTOP-722
|
|
// this type does not fully implement the interface it is expected to
|
|
} as unknown as MessageAttributesType;
|
|
|
|
const id = await window.Signal.Data.saveMessage(message, {
|
|
ourAci: window.textsecure.storage.user.getCheckedAci(),
|
|
});
|
|
const model = window.MessageCache.__DEPRECATED$register(
|
|
id,
|
|
new window.Whisper.Message({
|
|
...message,
|
|
id,
|
|
}),
|
|
'addChatSessionRefreshed'
|
|
);
|
|
|
|
this.trigger('newmessage', model);
|
|
void this.updateUnread();
|
|
}
|
|
|
|
async addDeliveryIssue({
|
|
receivedAt,
|
|
receivedAtCounter,
|
|
senderAci,
|
|
sentAt,
|
|
}: {
|
|
receivedAt: number;
|
|
receivedAtCounter: number;
|
|
senderAci: AciString;
|
|
sentAt: number;
|
|
}): Promise<void> {
|
|
log.info(`addDeliveryIssue: adding for ${this.idForLogging()}`, {
|
|
sentAt,
|
|
senderAci,
|
|
});
|
|
|
|
const message = {
|
|
conversationId: this.id,
|
|
type: 'delivery-issue',
|
|
sourceServiceId: senderAci,
|
|
sent_at: receivedAt,
|
|
received_at: receivedAtCounter,
|
|
received_at_ms: receivedAt,
|
|
readStatus: ReadStatus.Unread,
|
|
seenStatus: SeenStatus.Unseen,
|
|
// TODO: DESKTOP-722
|
|
// this type does not fully implement the interface it is expected to
|
|
} as unknown as MessageAttributesType;
|
|
|
|
const id = await window.Signal.Data.saveMessage(message, {
|
|
ourAci: window.textsecure.storage.user.getCheckedAci(),
|
|
});
|
|
const model = window.MessageCache.__DEPRECATED$register(
|
|
id,
|
|
new window.Whisper.Message({
|
|
...message,
|
|
id,
|
|
}),
|
|
'addDeliveryIssue'
|
|
);
|
|
|
|
this.trigger('newmessage', model);
|
|
|
|
await this.notify(model);
|
|
void this.updateUnread();
|
|
}
|
|
|
|
async addKeyChange(
|
|
reason: string,
|
|
keyChangedId?: ServiceIdString
|
|
): Promise<void> {
|
|
return this.queueJob(`addKeyChange(${keyChangedId})`, async () => {
|
|
log.info(
|
|
'adding key change advisory in',
|
|
this.idForLogging(),
|
|
'for',
|
|
keyChangedId || 'this conversation',
|
|
this.get('timestamp'),
|
|
'reason:',
|
|
reason
|
|
);
|
|
|
|
if (!keyChangedId && !isDirectConversation(this.attributes)) {
|
|
throw new Error(
|
|
'addKeyChange: Cannot omit keyChangedId in group conversation!'
|
|
);
|
|
}
|
|
|
|
const timestamp = Date.now();
|
|
const message: MessageAttributesType = {
|
|
id: generateGuid(),
|
|
conversationId: this.id,
|
|
type: 'keychange',
|
|
sent_at: timestamp,
|
|
timestamp,
|
|
received_at: incrementMessageCounter(),
|
|
received_at_ms: timestamp,
|
|
key_changed: keyChangedId,
|
|
readStatus: ReadStatus.Read,
|
|
seenStatus: SeenStatus.Unseen,
|
|
schemaVersion: Message.VERSION_NEEDED_FOR_DISPLAY,
|
|
};
|
|
|
|
await window.Signal.Data.saveMessage(message, {
|
|
ourAci: window.textsecure.storage.user.getCheckedAci(),
|
|
forceSave: true,
|
|
});
|
|
const model = window.MessageCache.__DEPRECATED$register(
|
|
message.id,
|
|
new window.Whisper.Message(message),
|
|
'addKeyChange'
|
|
);
|
|
|
|
this.trigger('newmessage', model);
|
|
|
|
const serviceId = this.getServiceId();
|
|
|
|
if (isDirectConversation(this.attributes)) {
|
|
window.reduxActions?.safetyNumber.clearSafetyNumber(this.id);
|
|
}
|
|
|
|
if (isDirectConversation(this.attributes) && serviceId) {
|
|
const groups =
|
|
await window.ConversationController.getAllGroupsInvolvingServiceId(
|
|
serviceId
|
|
);
|
|
groups.forEach(group => {
|
|
void group.addKeyChange('addKeyChange - group fan-out', serviceId);
|
|
});
|
|
}
|
|
|
|
// Reset sender key for next send
|
|
const senderKeyInfo = this.get('senderKeyInfo');
|
|
if (senderKeyInfo) {
|
|
await resetSenderKey(this.toSenderKeyTarget());
|
|
}
|
|
|
|
if (isDirectConversation(this.attributes)) {
|
|
this.captureChange(`addKeyChange(${reason})`);
|
|
}
|
|
});
|
|
}
|
|
|
|
async addConversationMerge(
|
|
renderInfo: ConversationRenderInfoType
|
|
): Promise<void> {
|
|
log.info(
|
|
`addConversationMerge/${this.idForLogging()}: Adding notification`
|
|
);
|
|
|
|
const timestamp = Date.now();
|
|
const message: MessageAttributesType = {
|
|
id: generateGuid(),
|
|
conversationId: this.id,
|
|
type: 'conversation-merge',
|
|
sent_at: timestamp,
|
|
timestamp,
|
|
received_at: incrementMessageCounter(),
|
|
received_at_ms: timestamp,
|
|
conversationMerge: {
|
|
renderInfo,
|
|
},
|
|
readStatus: ReadStatus.Read,
|
|
seenStatus: SeenStatus.Unseen,
|
|
schemaVersion: Message.VERSION_NEEDED_FOR_DISPLAY,
|
|
};
|
|
|
|
const id = await window.Signal.Data.saveMessage(message, {
|
|
ourAci: window.textsecure.storage.user.getCheckedAci(),
|
|
forceSave: true,
|
|
});
|
|
const model = window.MessageCache.__DEPRECATED$register(
|
|
id,
|
|
new window.Whisper.Message({
|
|
...message,
|
|
id,
|
|
}),
|
|
'addConversationMerge'
|
|
);
|
|
|
|
this.trigger('newmessage', model);
|
|
}
|
|
|
|
async addPhoneNumberDiscoveryIfNeeded(originalPni: PniString): Promise<void> {
|
|
const logId = `addPhoneNumberDiscoveryIfNeeded(${this.idForLogging()}, ${originalPni})`;
|
|
|
|
const e164 = this.get('e164');
|
|
|
|
if (!e164) {
|
|
log.info(`${logId}: not adding, no e164`);
|
|
return;
|
|
}
|
|
|
|
const hadSession = await window.textsecure.storage.protocol.hasSessionWith(
|
|
originalPni
|
|
);
|
|
|
|
if (!hadSession) {
|
|
log.info(`${logId}: not adding, no PNI session`);
|
|
return;
|
|
}
|
|
|
|
log.info(`${logId}: adding notification`);
|
|
const timestamp = Date.now();
|
|
const message: MessageAttributesType = {
|
|
id: generateGuid(),
|
|
conversationId: this.id,
|
|
type: 'phone-number-discovery',
|
|
sent_at: timestamp,
|
|
timestamp,
|
|
received_at: incrementMessageCounter(),
|
|
received_at_ms: timestamp,
|
|
phoneNumberDiscovery: {
|
|
e164,
|
|
},
|
|
readStatus: ReadStatus.Read,
|
|
seenStatus: SeenStatus.Unseen,
|
|
schemaVersion: Message.VERSION_NEEDED_FOR_DISPLAY,
|
|
};
|
|
|
|
const id = await window.Signal.Data.saveMessage(message, {
|
|
ourAci: window.textsecure.storage.user.getCheckedAci(),
|
|
forceSave: true,
|
|
});
|
|
const model = window.MessageCache.__DEPRECATED$register(
|
|
id,
|
|
new window.Whisper.Message({
|
|
...message,
|
|
id,
|
|
}),
|
|
'addPhoneNumberDiscoveryIfNeeded'
|
|
);
|
|
|
|
this.trigger('newmessage', model);
|
|
}
|
|
|
|
async addVerifiedChange(
|
|
verifiedChangeId: string,
|
|
verified: boolean,
|
|
options: { local?: boolean } = { local: true }
|
|
): Promise<void> {
|
|
if (isMe(this.attributes)) {
|
|
log.info('refusing to add verified change advisory for our own number');
|
|
return;
|
|
}
|
|
|
|
const lastMessage = this.get('timestamp') || Date.now();
|
|
|
|
log.info(
|
|
'adding verified change advisory for',
|
|
this.idForLogging(),
|
|
verifiedChangeId,
|
|
lastMessage
|
|
);
|
|
|
|
const timestamp = Date.now();
|
|
const message: MessageAttributesType = {
|
|
id: generateGuid(),
|
|
conversationId: this.id,
|
|
local: Boolean(options.local),
|
|
readStatus: ReadStatus.Read,
|
|
received_at_ms: timestamp,
|
|
received_at: incrementMessageCounter(),
|
|
seenStatus: options.local ? SeenStatus.Seen : SeenStatus.Unseen,
|
|
sent_at: lastMessage,
|
|
timestamp,
|
|
type: 'verified-change',
|
|
verified,
|
|
verifiedChanged: verifiedChangeId,
|
|
};
|
|
|
|
await window.Signal.Data.saveMessage(message, {
|
|
ourAci: window.textsecure.storage.user.getCheckedAci(),
|
|
forceSave: true,
|
|
});
|
|
const model = window.MessageCache.__DEPRECATED$register(
|
|
message.id,
|
|
new window.Whisper.Message(message),
|
|
'addVerifiedChange'
|
|
);
|
|
|
|
this.trigger('newmessage', model);
|
|
drop(this.updateUnread());
|
|
|
|
const serviceId = this.getServiceId();
|
|
if (isDirectConversation(this.attributes) && serviceId) {
|
|
void window.ConversationController.getAllGroupsInvolvingServiceId(
|
|
serviceId
|
|
).then(groups => {
|
|
groups.forEach(group => {
|
|
void group.addVerifiedChange(this.id, verified, options);
|
|
});
|
|
});
|
|
}
|
|
}
|
|
|
|
async addProfileChange(
|
|
profileChange: unknown,
|
|
conversationId?: string
|
|
): Promise<void> {
|
|
const now = Date.now();
|
|
const message = {
|
|
conversationId: this.id,
|
|
type: 'profile-change',
|
|
sent_at: now,
|
|
received_at: incrementMessageCounter(),
|
|
received_at_ms: now,
|
|
readStatus: ReadStatus.Read,
|
|
seenStatus: SeenStatus.NotApplicable,
|
|
changedId: conversationId || this.id,
|
|
profileChange,
|
|
// TODO: DESKTOP-722
|
|
} as unknown as MessageAttributesType;
|
|
|
|
const id = await window.Signal.Data.saveMessage(message, {
|
|
ourAci: window.textsecure.storage.user.getCheckedAci(),
|
|
});
|
|
const model = window.MessageCache.__DEPRECATED$register(
|
|
id,
|
|
new window.Whisper.Message({
|
|
...message,
|
|
id,
|
|
}),
|
|
'addProfileChange'
|
|
);
|
|
|
|
this.trigger('newmessage', model);
|
|
|
|
const serviceId = this.getServiceId();
|
|
if (isDirectConversation(this.attributes) && serviceId) {
|
|
this.set({ profileLastUpdatedAt: Date.now() });
|
|
|
|
void window.ConversationController.getAllGroupsInvolvingServiceId(
|
|
serviceId
|
|
).then(groups => {
|
|
groups.forEach(group => {
|
|
void group.addProfileChange(profileChange, this.id);
|
|
});
|
|
});
|
|
}
|
|
}
|
|
|
|
async addNotification(
|
|
type: MessageAttributesType['type'],
|
|
extra: Partial<MessageAttributesType> = {}
|
|
): Promise<string> {
|
|
const now = Date.now();
|
|
const message: Partial<MessageAttributesType> = {
|
|
conversationId: this.id,
|
|
type,
|
|
sent_at: now,
|
|
received_at: incrementMessageCounter(),
|
|
received_at_ms: now,
|
|
readStatus: ReadStatus.Read,
|
|
seenStatus: SeenStatus.NotApplicable,
|
|
|
|
...extra,
|
|
};
|
|
|
|
const id = await window.Signal.Data.saveMessage(
|
|
// TODO: DESKTOP-722
|
|
message as MessageAttributesType,
|
|
{
|
|
ourAci: window.textsecure.storage.user.getCheckedAci(),
|
|
}
|
|
);
|
|
const model = window.MessageCache.__DEPRECATED$register(
|
|
id,
|
|
new window.Whisper.Message({
|
|
...(message as MessageAttributesType),
|
|
id,
|
|
}),
|
|
'addNotification'
|
|
);
|
|
|
|
this.trigger('newmessage', model);
|
|
|
|
return id;
|
|
}
|
|
|
|
async maybeSetPendingUniversalTimer(
|
|
hasUserInitiatedMessages: boolean
|
|
): Promise<void> {
|
|
if (!isDirectConversation(this.attributes)) {
|
|
return;
|
|
}
|
|
|
|
if (this.isSMSOnly()) {
|
|
return;
|
|
}
|
|
|
|
if (isSignalConversation(this.attributes)) {
|
|
return;
|
|
}
|
|
|
|
if (hasUserInitiatedMessages) {
|
|
await this.maybeRemoveUniversalTimer();
|
|
return;
|
|
}
|
|
|
|
if (this.get('pendingUniversalTimer') || this.get('expireTimer')) {
|
|
return;
|
|
}
|
|
|
|
const expireTimer = universalExpireTimer.get();
|
|
if (!expireTimer) {
|
|
return;
|
|
}
|
|
|
|
log.info(
|
|
`maybeSetPendingUniversalTimer(${this.idForLogging()}): added notification`
|
|
);
|
|
const notificationId = await this.addNotification(
|
|
'universal-timer-notification'
|
|
);
|
|
this.set('pendingUniversalTimer', notificationId);
|
|
}
|
|
|
|
async maybeApplyUniversalTimer(): Promise<void> {
|
|
// Check if we had a notification
|
|
if (!(await this.maybeRemoveUniversalTimer())) {
|
|
return;
|
|
}
|
|
|
|
// We already have an expiration timer
|
|
if (this.get('expireTimer')) {
|
|
return;
|
|
}
|
|
|
|
const expireTimer = universalExpireTimer.get();
|
|
if (expireTimer) {
|
|
log.info(
|
|
`maybeApplyUniversalTimer(${this.idForLogging()}): applying timer`
|
|
);
|
|
|
|
await this.updateExpirationTimer(expireTimer, {
|
|
reason: 'maybeApplyUniversalTimer',
|
|
});
|
|
}
|
|
}
|
|
|
|
async maybeRemoveUniversalTimer(): Promise<boolean> {
|
|
const notificationId = this.get('pendingUniversalTimer');
|
|
if (!notificationId) {
|
|
return false;
|
|
}
|
|
|
|
this.set('pendingUniversalTimer', undefined);
|
|
log.info(
|
|
`maybeRemoveUniversalTimer(${this.idForLogging()}): removed notification`
|
|
);
|
|
|
|
const message = window.MessageCache.__DEPRECATED$getById(notificationId);
|
|
if (message) {
|
|
await window.Signal.Data.removeMessage(message.id);
|
|
}
|
|
return true;
|
|
}
|
|
|
|
async maybeSetContactRemoved(): Promise<void> {
|
|
if (!isDirectConversation(this.attributes)) {
|
|
return;
|
|
}
|
|
|
|
if (this.get('pendingRemovedContactNotification')) {
|
|
return;
|
|
}
|
|
|
|
log.info(
|
|
`maybeSetContactRemoved(${this.idForLogging()}): added notification`
|
|
);
|
|
const notificationId = await this.addNotification(
|
|
'contact-removed-notification'
|
|
);
|
|
this.set('pendingRemovedContactNotification', notificationId);
|
|
await window.Signal.Data.updateConversation(this.attributes);
|
|
}
|
|
|
|
async maybeClearContactRemoved(): Promise<boolean> {
|
|
const notificationId = this.get('pendingRemovedContactNotification');
|
|
if (!notificationId) {
|
|
return false;
|
|
}
|
|
|
|
this.set('pendingRemovedContactNotification', undefined);
|
|
log.info(
|
|
`maybeClearContactRemoved(${this.idForLogging()}): removed notification`
|
|
);
|
|
|
|
const message = window.MessageCache.__DEPRECATED$getById(notificationId);
|
|
if (message) {
|
|
await window.Signal.Data.removeMessage(message.id);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
async addChangeNumberNotification(
|
|
oldValue: string,
|
|
newValue: string
|
|
): Promise<void> {
|
|
const sourceServiceId = this.getCheckedServiceId(
|
|
'Change number notification without service id'
|
|
);
|
|
|
|
const { storage } = window.textsecure;
|
|
if (
|
|
storage.user.getOurServiceIdKind(sourceServiceId) !==
|
|
ServiceIdKind.Unknown
|
|
) {
|
|
log.info(
|
|
`Conversation ${this.idForLogging()}: not adding change number ` +
|
|
'notification for ourselves'
|
|
);
|
|
return;
|
|
}
|
|
|
|
log.info(
|
|
`Conversation ${this.idForLogging()}: adding change number ` +
|
|
`notification for ${sourceServiceId} from ${oldValue} to ${newValue}`
|
|
);
|
|
|
|
const convos = [
|
|
this,
|
|
...(await window.ConversationController.getAllGroupsInvolvingServiceId(
|
|
sourceServiceId
|
|
)),
|
|
];
|
|
|
|
await Promise.all(
|
|
convos.map(convo => {
|
|
return convo.addNotification('change-number-notification', {
|
|
readStatus: ReadStatus.Read,
|
|
seenStatus: SeenStatus.Unseen,
|
|
sourceServiceId,
|
|
});
|
|
})
|
|
);
|
|
}
|
|
|
|
async onReadMessage(
|
|
message: MessageModel,
|
|
readAt?: number,
|
|
newestSentAt?: number
|
|
): Promise<void> {
|
|
// We mark as read everything older than this message - to clean up old stuff
|
|
// still marked unread in the database. If the user generally doesn't read in
|
|
// the desktop app, so the desktop app only gets read syncs, we can very
|
|
// easily end up with messages never marked as read (our previous early read
|
|
// sync handling, read syncs never sent because app was offline)
|
|
|
|
// We queue it because we often get a whole lot of read syncs at once, and
|
|
// their markRead calls could very easily overlap given the async pull from DB.
|
|
|
|
// Lastly, we don't send read syncs for any message marked read due to a read
|
|
// sync. That's a notification explosion we don't need.
|
|
return this.queueJob('onReadMessage', () =>
|
|
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
|
|
this.markRead(message.get('received_at')!, {
|
|
newestSentAt: newestSentAt || message.get('sent_at'),
|
|
sendReadReceipts: false,
|
|
readAt,
|
|
})
|
|
);
|
|
}
|
|
|
|
override validate(attributes = this.attributes): string | null {
|
|
return validateConversation(attributes);
|
|
}
|
|
|
|
async queueJob<T>(
|
|
name: string,
|
|
callback: (abortSignal: AbortSignal) => Promise<T>
|
|
): Promise<T> {
|
|
const logId = `conversation.queueJob(${this.idForLogging()}, ${name})`;
|
|
|
|
if (this.isShuttingDown) {
|
|
log.warn(`${logId}: shutting down, can't accept more work`);
|
|
throw new Error(`${logId}: shutting down, can't accept more work`);
|
|
}
|
|
|
|
this.jobQueue = this.jobQueue || new PQueue({ concurrency: 1 });
|
|
|
|
const taskWithTimeout = createTaskWithTimeout(callback, logId);
|
|
|
|
const abortController = new AbortController();
|
|
const { signal: abortSignal } = abortController;
|
|
|
|
const queuedAt = Date.now();
|
|
return this.jobQueue.add(async () => {
|
|
const startedAt = Date.now();
|
|
const waitTime = startedAt - queuedAt;
|
|
|
|
if (waitTime > JOB_REPORTING_THRESHOLD_MS) {
|
|
log.info(`${logId}: was blocked for ${waitTime}ms`);
|
|
}
|
|
|
|
try {
|
|
return await taskWithTimeout(abortSignal);
|
|
} catch (error) {
|
|
abortController.abort();
|
|
throw error;
|
|
} finally {
|
|
const duration = Date.now() - startedAt;
|
|
|
|
if (duration > JOB_REPORTING_THRESHOLD_MS) {
|
|
log.info(`${logId}: took ${duration}ms`);
|
|
}
|
|
}
|
|
});
|
|
}
|
|
|
|
isAdmin(serviceId: ServiceIdString): boolean {
|
|
if (!isGroupV2(this.attributes)) {
|
|
return false;
|
|
}
|
|
|
|
const members = this.get('membersV2') || [];
|
|
const member = members.find(x => x.aci === serviceId);
|
|
if (!member) {
|
|
return false;
|
|
}
|
|
|
|
const MEMBER_ROLES = Proto.Member.Role;
|
|
|
|
return member.role === MEMBER_ROLES.ADMINISTRATOR;
|
|
}
|
|
|
|
getServiceId(): ServiceIdString | undefined {
|
|
return this.get('serviceId');
|
|
}
|
|
|
|
getCheckedServiceId(reason: string): ServiceIdString {
|
|
const serviceId = this.getServiceId();
|
|
strictAssert(serviceId !== undefined, reason);
|
|
return serviceId;
|
|
}
|
|
|
|
getAci(): AciString | undefined {
|
|
const value = this.getServiceId();
|
|
if (value && isAciString(value)) {
|
|
return value;
|
|
}
|
|
return undefined;
|
|
}
|
|
|
|
getCheckedAci(reason: string): AciString {
|
|
const aci = this.getAci();
|
|
strictAssert(aci !== undefined, reason);
|
|
return aci;
|
|
}
|
|
|
|
getPni(): PniString | undefined {
|
|
return this.get('pni');
|
|
}
|
|
|
|
getGroupLink(): string | undefined {
|
|
if (!isGroupV2(this.attributes)) {
|
|
return undefined;
|
|
}
|
|
|
|
if (!this.get('groupInviteLinkPassword')) {
|
|
return undefined;
|
|
}
|
|
|
|
return window.Signal.Groups.buildGroupLink(this.attributes);
|
|
}
|
|
|
|
getMembers(
|
|
options: { includePendingMembers?: boolean } = {}
|
|
): Array<ConversationModel> {
|
|
return compact(
|
|
getConversationMembers(this.attributes, options).map(conversationAttrs =>
|
|
window.ConversationController.get(conversationAttrs.id)
|
|
)
|
|
);
|
|
}
|
|
|
|
canBeAnnouncementGroup(): boolean {
|
|
if (!isGroupV2(this.attributes)) {
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
getMemberIds(): Array<string> {
|
|
const members = this.getMembers();
|
|
return members.map(member => member.id);
|
|
}
|
|
|
|
getRecipients({
|
|
includePendingMembers,
|
|
extraConversationsForSend,
|
|
}: {
|
|
includePendingMembers?: boolean;
|
|
extraConversationsForSend?: ReadonlyArray<string>;
|
|
isStoryReply?: boolean;
|
|
} = {}): Array<ServiceIdString> {
|
|
return getRecipients(this.attributes, {
|
|
includePendingMembers,
|
|
extraConversationsForSend,
|
|
});
|
|
}
|
|
|
|
// Members is all people in the group
|
|
getMemberConversationIds(): Set<string> {
|
|
return new Set(map(this.getMembers(), conversation => conversation.id));
|
|
}
|
|
|
|
async getQuoteAttachment(
|
|
attachments?: Array<AttachmentType>,
|
|
preview?: Array<LinkPreviewType>,
|
|
sticker?: StickerType
|
|
): Promise<
|
|
Array<{
|
|
contentType: MIMEType;
|
|
fileName?: string | null;
|
|
thumbnail?: ThumbnailType | null;
|
|
}>
|
|
> {
|
|
return getQuoteAttachment(attachments, preview, sticker);
|
|
}
|
|
|
|
async sendStickerMessage(packId: string, stickerId: number): Promise<void> {
|
|
const packData = Stickers.getStickerPack(packId);
|
|
const stickerData = Stickers.getSticker(packId, stickerId);
|
|
if (!stickerData || !packData) {
|
|
log.warn(
|
|
`Attempted to send nonexistent (${packId}, ${stickerId}) sticker!`
|
|
);
|
|
return;
|
|
}
|
|
|
|
const { key } = packData;
|
|
const { emoji, path, width, height } = stickerData;
|
|
const data = await readStickerData(path);
|
|
|
|
// We need this content type to be an image so we can display an `<img>` instead of a
|
|
// `<video>` or an error, but it's not critical that we get the full type correct.
|
|
// In other words, it's probably fine if we say that a GIF is `image/png`, but it's
|
|
// but it's bad if we say it's `video/mp4` or `text/plain`. We do our best to sniff
|
|
// the MIME type here, but it's okay if we have to use a possibly-incorrect
|
|
// fallback.
|
|
let contentType: MIMEType;
|
|
const sniffedMimeType = sniffImageMimeType(data);
|
|
if (sniffedMimeType) {
|
|
contentType = sniffedMimeType;
|
|
} else {
|
|
log.warn(
|
|
'sendStickerMessage: Unable to sniff sticker MIME type; falling back to WebP'
|
|
);
|
|
contentType = IMAGE_WEBP;
|
|
}
|
|
|
|
const sticker: StickerWithHydratedData = {
|
|
packId,
|
|
stickerId,
|
|
packKey: key,
|
|
emoji,
|
|
data: {
|
|
size: data.byteLength,
|
|
data,
|
|
contentType,
|
|
width,
|
|
height,
|
|
blurHash: await imageToBlurHash(
|
|
new Blob([data], {
|
|
type: IMAGE_JPEG,
|
|
})
|
|
),
|
|
},
|
|
};
|
|
|
|
drop(
|
|
this.enqueueMessageForSend(
|
|
{
|
|
body: undefined,
|
|
attachments: [],
|
|
sticker,
|
|
},
|
|
{ dontClearDraft: true }
|
|
)
|
|
);
|
|
window.reduxActions.stickers.useSticker(packId, stickerId);
|
|
}
|
|
|
|
async sendProfileKeyUpdate(): Promise<void> {
|
|
if (isMe(this.attributes)) {
|
|
return;
|
|
}
|
|
|
|
if (!this.get('profileSharing')) {
|
|
log.error(
|
|
'sendProfileKeyUpdate: profileSharing not enabled for conversation',
|
|
this.idForLogging()
|
|
);
|
|
return;
|
|
}
|
|
|
|
try {
|
|
await conversationJobQueue.add({
|
|
type: conversationQueueJobEnum.enum.ProfileKey,
|
|
conversationId: this.id,
|
|
revision: this.get('revision'),
|
|
});
|
|
} catch (error) {
|
|
log.error(
|
|
'sendProfileKeyUpdate: Failed to queue profile share',
|
|
Errors.toLogFormat(error)
|
|
);
|
|
}
|
|
}
|
|
|
|
batchReduxChanges(callback: () => void): void {
|
|
strictAssert(!this.isInReduxBatch, 'Nested redux batching is not allowed');
|
|
this.isInReduxBatch = true;
|
|
batchDispatch(() => {
|
|
try {
|
|
callback();
|
|
} finally {
|
|
this.isInReduxBatch = false;
|
|
}
|
|
});
|
|
}
|
|
|
|
beforeMessageSend({
|
|
message,
|
|
dontAddMessage,
|
|
dontClearDraft,
|
|
now,
|
|
extraReduxActions,
|
|
}: {
|
|
message: MessageModel;
|
|
dontAddMessage: boolean;
|
|
dontClearDraft: boolean;
|
|
now: number;
|
|
extraReduxActions?: () => void;
|
|
}): void {
|
|
this.batchReduxChanges(() => {
|
|
const { clearUnreadMetrics } = window.reduxActions.conversations;
|
|
clearUnreadMetrics(this.id);
|
|
|
|
const enabledProfileSharing = Boolean(!this.get('profileSharing'));
|
|
const unarchivedConversation = Boolean(this.get('isArchived'));
|
|
|
|
log.info(
|
|
`beforeMessageSend(${this.idForLogging()}): ` +
|
|
`clearDraft(${!dontClearDraft}) addMessage(${!dontAddMessage})`
|
|
);
|
|
|
|
if (!dontAddMessage) {
|
|
this.doAddSingleMessage(message, { isJustSent: true });
|
|
}
|
|
const notificationData = message.getNotificationData();
|
|
const draftProperties = dontClearDraft
|
|
? {}
|
|
: {
|
|
draft: '',
|
|
draftEditMessage: undefined,
|
|
draftBodyRanges: [],
|
|
draftTimestamp: null,
|
|
quotedMessageId: undefined,
|
|
lastMessageAuthor: getMessageAuthorText(message.attributes),
|
|
lastMessageBodyRanges: message.get('bodyRanges'),
|
|
lastMessage:
|
|
notificationData?.text || message.getNotificationText() || '',
|
|
lastMessageStatus: 'sending' as const,
|
|
};
|
|
|
|
const isEditMessage = Boolean(message.get('editHistory'));
|
|
|
|
this.set({
|
|
...draftProperties,
|
|
...(enabledProfileSharing ? { profileSharing: true } : {}),
|
|
...(dontAddMessage
|
|
? {}
|
|
: this.incrementSentMessageCount({ dry: true })),
|
|
// If it's an edit message we don't want to optimistically set the
|
|
// active_at & timestamp to now. We want it to stay the same.
|
|
active_at: isEditMessage ? this.get('active_at') : now,
|
|
timestamp: isEditMessage ? this.get('timestamp') : now,
|
|
...(unarchivedConversation ? { isArchived: false } : {}),
|
|
});
|
|
|
|
if (enabledProfileSharing) {
|
|
this.captureChange('beforeMessageSend/mandatoryProfileSharing');
|
|
}
|
|
if (unarchivedConversation) {
|
|
this.captureChange('beforeMessageSend/unarchive');
|
|
}
|
|
|
|
extraReduxActions?.();
|
|
});
|
|
}
|
|
|
|
async enqueueMessageForSend(
|
|
{
|
|
attachments,
|
|
body,
|
|
contact,
|
|
bodyRanges,
|
|
preview,
|
|
quote,
|
|
sticker,
|
|
}: {
|
|
attachments: Array<AttachmentType>;
|
|
body: string | undefined;
|
|
contact?: Array<EmbeddedContactWithHydratedAvatar>;
|
|
bodyRanges?: DraftBodyRanges;
|
|
preview?: Array<LinkPreviewWithHydratedData>;
|
|
quote?: QuotedMessageType;
|
|
sticker?: StickerWithHydratedData;
|
|
},
|
|
{
|
|
dontClearDraft = false,
|
|
sendHQImages,
|
|
storyId,
|
|
timestamp,
|
|
extraReduxActions,
|
|
}: {
|
|
dontClearDraft?: boolean;
|
|
sendHQImages?: boolean;
|
|
storyId?: string;
|
|
timestamp?: number;
|
|
extraReduxActions?: () => void;
|
|
} = {}
|
|
): Promise<MessageAttributesType | undefined> {
|
|
if (this.isGroupV1AndDisabled()) {
|
|
return;
|
|
}
|
|
|
|
if (isSignalConversation(this.attributes)) {
|
|
return;
|
|
}
|
|
|
|
const now = timestamp || Date.now();
|
|
|
|
log.info(
|
|
'Sending message to conversation',
|
|
this.idForLogging(),
|
|
'with timestamp',
|
|
now
|
|
);
|
|
|
|
this.clearTypingTimers();
|
|
|
|
let expirationStartTimestamp: number | undefined;
|
|
let expireTimer: DurationInSeconds | undefined;
|
|
|
|
// For normal messages and 1:1 story replies, we use the parent conversation's timer
|
|
if (!storyId || isDirectConversation(this.attributes)) {
|
|
await this.maybeApplyUniversalTimer();
|
|
expireTimer = this.get('expireTimer');
|
|
}
|
|
|
|
const recipientMaybeConversations = map(
|
|
this.getRecipients({
|
|
isStoryReply: storyId !== undefined,
|
|
}),
|
|
identifier => window.ConversationController.get(identifier)
|
|
);
|
|
const recipientConversations = filter(
|
|
recipientMaybeConversations,
|
|
isNotNil
|
|
);
|
|
const recipientConversationIds = concat(
|
|
map(recipientConversations, c => c.id),
|
|
[window.ConversationController.getOurConversationIdOrThrow()]
|
|
);
|
|
|
|
// If there are link previews present in the message we shouldn't include
|
|
// any attachments as well.
|
|
let attachmentsToSend = preview && preview.length ? [] : attachments;
|
|
|
|
if (preview && preview.length) {
|
|
attachments.forEach(attachment => {
|
|
if (attachment.path) {
|
|
void deleteAttachmentData(attachment.path);
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* At this point, all attachments have been processed and written to disk as draft
|
|
* attachments, via processAttachments. All transcodable images have been re-encoded
|
|
* via canvas to remove EXIF data. Images above the high-quality threshold size have
|
|
* been scaled to high-quality JPEGs.
|
|
*
|
|
* If we choose to send images in standard quality, we need to scale them down
|
|
* (potentially for the second time). When we do so, we also delete the current
|
|
* draft attachment on disk for cleanup.
|
|
*
|
|
* All draft attachments (with a path or just in-memory) will be written to disk for
|
|
* real in `upgradeMessageSchema`.
|
|
*/
|
|
if (!sendHQImages) {
|
|
attachmentsToSend = await Promise.all(
|
|
attachmentsToSend.map(async attachment => {
|
|
const downscaledAttachment = await downscaleOutgoingAttachment(
|
|
attachment
|
|
);
|
|
if (downscaledAttachment !== attachment && attachment.path) {
|
|
drop(deleteAttachmentData(attachment.path));
|
|
}
|
|
return downscaledAttachment;
|
|
})
|
|
);
|
|
}
|
|
|
|
// Here we move attachments to disk
|
|
const attributes = await upgradeMessageSchema({
|
|
id: generateGuid(),
|
|
timestamp: now,
|
|
type: 'outgoing',
|
|
body,
|
|
conversationId: this.id,
|
|
contact,
|
|
quote,
|
|
preview,
|
|
attachments: attachmentsToSend,
|
|
sent_at: now,
|
|
received_at: incrementMessageCounter(),
|
|
received_at_ms: now,
|
|
expirationStartTimestamp,
|
|
expireTimer,
|
|
readStatus: ReadStatus.Read,
|
|
seenStatus: SeenStatus.NotApplicable,
|
|
sticker,
|
|
bodyRanges,
|
|
sendHQImages,
|
|
sendStateByConversationId: zipObject(
|
|
recipientConversationIds,
|
|
repeat({
|
|
status: SendStatus.Pending,
|
|
updatedAt: now,
|
|
})
|
|
),
|
|
storyId,
|
|
});
|
|
|
|
const model = new window.Whisper.Message(attributes);
|
|
const message = window.MessageCache.__DEPRECATED$register(
|
|
model.id,
|
|
model,
|
|
'enqueueMessageForSend'
|
|
);
|
|
message.cachedOutgoingContactData = contact;
|
|
|
|
// Attach path to preview images so that sendNormalMessage can use them to
|
|
// update digests on attachments.
|
|
if (preview) {
|
|
message.cachedOutgoingPreviewData = preview.map((item, index) => {
|
|
if (!item.image) {
|
|
return item;
|
|
}
|
|
|
|
return {
|
|
...item,
|
|
image: {
|
|
...item.image,
|
|
path: attributes.preview?.at(index)?.image?.path,
|
|
},
|
|
};
|
|
});
|
|
}
|
|
message.cachedOutgoingQuoteData = quote;
|
|
message.cachedOutgoingStickerData = sticker;
|
|
|
|
const dbStart = Date.now();
|
|
|
|
strictAssert(
|
|
typeof message.attributes.timestamp === 'number',
|
|
'Expected a timestamp'
|
|
);
|
|
|
|
await conversationJobQueue.add(
|
|
{
|
|
type: conversationQueueJobEnum.enum.NormalMessage,
|
|
conversationId: this.id,
|
|
messageId: message.id,
|
|
revision: this.get('revision'),
|
|
},
|
|
async jobToInsert => {
|
|
log.info(
|
|
`enqueueMessageForSend: saving message ${message.id} and job ${jobToInsert.id}`
|
|
);
|
|
await window.Signal.Data.saveMessage(message.attributes, {
|
|
jobToInsert,
|
|
forceSave: true,
|
|
ourAci: window.textsecure.storage.user.getCheckedAci(),
|
|
});
|
|
}
|
|
);
|
|
|
|
const dbDuration = Date.now() - dbStart;
|
|
if (dbDuration > SEND_REPORTING_THRESHOLD_MS) {
|
|
log.info(
|
|
`ConversationModel(${this.idForLogging()}.sendMessage(${now}): ` +
|
|
`db save took ${dbDuration}ms`
|
|
);
|
|
}
|
|
|
|
const renderStart = Date.now();
|
|
|
|
// Perform asynchronous tasks before entering the batching mode
|
|
await this.beforeAddSingleMessage(model);
|
|
|
|
if (sticker) {
|
|
await addStickerPackReference(model.id, sticker.packId);
|
|
}
|
|
|
|
this.beforeMessageSend({
|
|
message: model,
|
|
dontClearDraft,
|
|
dontAddMessage: false,
|
|
now,
|
|
extraReduxActions,
|
|
});
|
|
|
|
// The call above enables profile sharing so we have to restore contact
|
|
// afterwards, otherwise Message Request state will flash.
|
|
if (!storyId || isDirectConversation(this.attributes)) {
|
|
await this.restoreContact();
|
|
}
|
|
|
|
const renderDuration = Date.now() - renderStart;
|
|
|
|
if (renderDuration > SEND_REPORTING_THRESHOLD_MS) {
|
|
log.info(
|
|
`ConversationModel(${this.idForLogging()}.sendMessage(${now}): ` +
|
|
`render save took ${renderDuration}ms`
|
|
);
|
|
}
|
|
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
|
|
return attributes;
|
|
}
|
|
|
|
// Is this someone who is a contact, or are we sharing our profile with them?
|
|
// Or is the person who added us to this group a contact or are we sharing profile
|
|
// with them?
|
|
isFromOrAddedByTrustedContact(): boolean {
|
|
if (isDirectConversation(this.attributes)) {
|
|
return Boolean(this.get('name')) || Boolean(this.get('profileSharing'));
|
|
}
|
|
|
|
const addedBy = this.get('addedBy');
|
|
if (!addedBy) {
|
|
return false;
|
|
}
|
|
|
|
const conv = window.ConversationController.get(addedBy);
|
|
if (!conv) {
|
|
return false;
|
|
}
|
|
|
|
return Boolean(
|
|
isMe(conv.attributes) || conv.get('name') || conv.get('profileSharing')
|
|
);
|
|
}
|
|
|
|
async maybeClearUsername(): Promise<void> {
|
|
const ourConversationId =
|
|
window.ConversationController.getOurConversationId();
|
|
|
|
const oldUsername = this.get('username');
|
|
|
|
// Clear username once we have other information about the contact
|
|
if (canHaveUsername(this.attributes, ourConversationId) || !oldUsername) {
|
|
return;
|
|
}
|
|
|
|
log.info(`maybeClearUsername(${this.idForLogging()}): clearing username`);
|
|
|
|
this.unset('username');
|
|
|
|
if (this.get('needsTitleTransition') && getProfileName(this.attributes)) {
|
|
log.info(
|
|
`maybeClearUsername(${this.idForLogging()}): adding a notification`
|
|
);
|
|
const { type, e164, username } = this.attributes;
|
|
|
|
this.unset('needsTitleTransition');
|
|
|
|
await this.addNotification('title-transition-notification', {
|
|
readStatus: ReadStatus.Read,
|
|
seenStatus: SeenStatus.Unseen,
|
|
titleTransition: {
|
|
renderInfo: {
|
|
type,
|
|
e164,
|
|
username,
|
|
},
|
|
},
|
|
});
|
|
}
|
|
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
this.captureChange('clearUsername');
|
|
}
|
|
|
|
async updateUsername(
|
|
username: string | undefined,
|
|
{ shouldSave = true }: { shouldSave?: boolean } = {}
|
|
): Promise<void> {
|
|
const ourConversationId =
|
|
window.ConversationController.getOurConversationId();
|
|
|
|
if (!canHaveUsername(this.attributes, ourConversationId)) {
|
|
return;
|
|
}
|
|
|
|
if (this.get('username') === username) {
|
|
return;
|
|
}
|
|
|
|
log.info(`updateUsername(${this.idForLogging()}): updating username`);
|
|
|
|
this.set('username', username);
|
|
this.captureChange('updateUsername');
|
|
|
|
if (shouldSave) {
|
|
await window.Signal.Data.updateConversation(this.attributes);
|
|
}
|
|
}
|
|
|
|
async updateLastMessage(): Promise<void> {
|
|
if (!this.id) {
|
|
return;
|
|
}
|
|
|
|
const ourConversationId =
|
|
window.ConversationController.getOurConversationId();
|
|
if (!ourConversationId) {
|
|
throw new Error('updateLastMessage: Failed to fetch ourConversationId');
|
|
}
|
|
|
|
const conversationId = this.id;
|
|
|
|
const stats = await window.Signal.Data.getConversationMessageStats({
|
|
conversationId,
|
|
includeStoryReplies: !isGroup(this.attributes),
|
|
});
|
|
|
|
// This runs as a job to avoid race conditions
|
|
drop(
|
|
this.queueJob('maybeSetPendingUniversalTimer', async () =>
|
|
this.maybeSetPendingUniversalTimer(stats.hasUserInitiatedMessages)
|
|
)
|
|
);
|
|
|
|
const { preview, activity } = stats;
|
|
let previewMessage: MessageModel | undefined;
|
|
let activityMessage: MessageModel | undefined;
|
|
|
|
// Register the message with MessageCache so that if it already exists
|
|
// in memory we use that data instead of the data from the db which may
|
|
// be out of date.
|
|
if (preview) {
|
|
previewMessage = window.MessageCache.__DEPRECATED$register(
|
|
preview.id,
|
|
preview,
|
|
'previewMessage'
|
|
);
|
|
}
|
|
|
|
if (activity) {
|
|
activityMessage = window.MessageCache.__DEPRECATED$register(
|
|
activity.id,
|
|
activity,
|
|
'activityMessage'
|
|
);
|
|
}
|
|
|
|
if (
|
|
this.hasDraft() &&
|
|
this.get('draftTimestamp') &&
|
|
(!previewMessage ||
|
|
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
|
|
previewMessage.get('sent_at') < this.get('draftTimestamp')!)
|
|
) {
|
|
return;
|
|
}
|
|
|
|
let timestamp = this.get('timestamp') || null;
|
|
let lastMessageReceivedAt = this.get('lastMessageReceivedAt');
|
|
let lastMessageReceivedAtMs = this.get('lastMessageReceivedAtMs');
|
|
if (activityMessage) {
|
|
timestamp =
|
|
activityMessage.get('editMessageTimestamp') ||
|
|
activityMessage.get('sent_at') ||
|
|
timestamp;
|
|
lastMessageReceivedAt =
|
|
activityMessage.get('editMessageReceivedAt') ||
|
|
activityMessage.get('received_at') ||
|
|
lastMessageReceivedAt;
|
|
lastMessageReceivedAtMs =
|
|
activityMessage.get('editMessageReceivedAtMs') ||
|
|
activityMessage.get('received_at_ms') ||
|
|
lastMessageReceivedAtMs;
|
|
}
|
|
|
|
const notificationData = previewMessage?.getNotificationData();
|
|
|
|
this.set({
|
|
lastMessage:
|
|
notificationData?.text || previewMessage?.getNotificationText() || '',
|
|
lastMessageBodyRanges: notificationData?.bodyRanges,
|
|
lastMessagePrefix: notificationData?.emoji,
|
|
lastMessageAuthor: getMessageAuthorText(previewMessage?.attributes),
|
|
lastMessageStatus:
|
|
(previewMessage
|
|
? getMessagePropStatus(previewMessage.attributes, ourConversationId)
|
|
: null) || null,
|
|
lastMessageReceivedAt,
|
|
lastMessageReceivedAtMs,
|
|
timestamp,
|
|
lastMessageDeletedForEveryone: previewMessage
|
|
? previewMessage.get('deletedForEveryone')
|
|
: false,
|
|
});
|
|
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
}
|
|
|
|
setArchived(isArchived: boolean): void {
|
|
const before = this.get('isArchived');
|
|
|
|
this.set({ isArchived });
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
|
|
const after = this.get('isArchived');
|
|
|
|
if (Boolean(before) !== Boolean(after)) {
|
|
if (after) {
|
|
this.unpin();
|
|
}
|
|
this.captureChange('isArchived');
|
|
}
|
|
}
|
|
|
|
setMarkedUnread(markedUnread: boolean): void {
|
|
const previousMarkedUnread = this.get('markedUnread');
|
|
|
|
this.set({ markedUnread });
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
|
|
if (Boolean(previousMarkedUnread) !== Boolean(markedUnread)) {
|
|
this.captureChange('markedUnread');
|
|
}
|
|
}
|
|
|
|
async refreshGroupLink(): Promise<void> {
|
|
if (!isGroupV2(this.attributes)) {
|
|
return;
|
|
}
|
|
|
|
const groupInviteLinkPassword = Bytes.toBase64(
|
|
window.Signal.Groups.generateGroupInviteLinkPassword()
|
|
);
|
|
|
|
log.info('refreshGroupLink for conversation', this.idForLogging());
|
|
|
|
await this.modifyGroupV2({
|
|
name: 'updateInviteLinkPassword',
|
|
usingCredentialsFrom: [],
|
|
createGroupChange: async () =>
|
|
window.Signal.Groups.buildInviteLinkPasswordChange(
|
|
this.attributes,
|
|
groupInviteLinkPassword
|
|
),
|
|
});
|
|
|
|
this.set({ groupInviteLinkPassword });
|
|
}
|
|
|
|
async toggleGroupLink(value: boolean): Promise<void> {
|
|
if (!isGroupV2(this.attributes)) {
|
|
return;
|
|
}
|
|
|
|
const shouldCreateNewGroupLink =
|
|
value && !this.get('groupInviteLinkPassword');
|
|
const groupInviteLinkPassword =
|
|
this.get('groupInviteLinkPassword') ||
|
|
Bytes.toBase64(window.Signal.Groups.generateGroupInviteLinkPassword());
|
|
|
|
log.info('toggleGroupLink for conversation', this.idForLogging(), value);
|
|
|
|
const ACCESS_ENUM = Proto.AccessControl.AccessRequired;
|
|
const addFromInviteLink = value
|
|
? ACCESS_ENUM.ANY
|
|
: ACCESS_ENUM.UNSATISFIABLE;
|
|
|
|
if (shouldCreateNewGroupLink) {
|
|
await this.modifyGroupV2({
|
|
name: 'updateNewGroupLink',
|
|
usingCredentialsFrom: [],
|
|
createGroupChange: async () =>
|
|
window.Signal.Groups.buildNewGroupLinkChange(
|
|
this.attributes,
|
|
groupInviteLinkPassword,
|
|
addFromInviteLink
|
|
),
|
|
});
|
|
} else {
|
|
await this.modifyGroupV2({
|
|
name: 'updateAccessControlAddFromInviteLink',
|
|
usingCredentialsFrom: [],
|
|
createGroupChange: async () =>
|
|
window.Signal.Groups.buildAccessControlAddFromInviteLinkChange(
|
|
this.attributes,
|
|
addFromInviteLink
|
|
),
|
|
});
|
|
}
|
|
|
|
this.set({
|
|
accessControl: {
|
|
addFromInviteLink,
|
|
attributes: this.get('accessControl')?.attributes || ACCESS_ENUM.MEMBER,
|
|
members: this.get('accessControl')?.members || ACCESS_ENUM.MEMBER,
|
|
},
|
|
});
|
|
|
|
if (shouldCreateNewGroupLink) {
|
|
this.set({ groupInviteLinkPassword });
|
|
}
|
|
}
|
|
|
|
async updateAccessControlAddFromInviteLink(value: boolean): Promise<void> {
|
|
if (!isGroupV2(this.attributes)) {
|
|
return;
|
|
}
|
|
|
|
const ACCESS_ENUM = Proto.AccessControl.AccessRequired;
|
|
|
|
const addFromInviteLink = value
|
|
? ACCESS_ENUM.ADMINISTRATOR
|
|
: ACCESS_ENUM.ANY;
|
|
|
|
await this.modifyGroupV2({
|
|
name: 'updateAccessControlAddFromInviteLink',
|
|
usingCredentialsFrom: [],
|
|
createGroupChange: async () =>
|
|
window.Signal.Groups.buildAccessControlAddFromInviteLinkChange(
|
|
this.attributes,
|
|
addFromInviteLink
|
|
),
|
|
});
|
|
|
|
this.set({
|
|
accessControl: {
|
|
addFromInviteLink,
|
|
attributes: this.get('accessControl')?.attributes || ACCESS_ENUM.MEMBER,
|
|
members: this.get('accessControl')?.members || ACCESS_ENUM.MEMBER,
|
|
},
|
|
});
|
|
}
|
|
|
|
async updateAccessControlAttributes(value: number): Promise<void> {
|
|
if (!isGroupV2(this.attributes)) {
|
|
return;
|
|
}
|
|
|
|
await this.modifyGroupV2({
|
|
name: 'updateAccessControlAttributes',
|
|
usingCredentialsFrom: [],
|
|
createGroupChange: async () =>
|
|
window.Signal.Groups.buildAccessControlAttributesChange(
|
|
this.attributes,
|
|
value
|
|
),
|
|
});
|
|
|
|
const ACCESS_ENUM = Proto.AccessControl.AccessRequired;
|
|
this.set({
|
|
accessControl: {
|
|
addFromInviteLink:
|
|
this.get('accessControl')?.addFromInviteLink || ACCESS_ENUM.MEMBER,
|
|
attributes: value,
|
|
members: this.get('accessControl')?.members || ACCESS_ENUM.MEMBER,
|
|
},
|
|
});
|
|
}
|
|
|
|
async updateAccessControlMembers(value: number): Promise<void> {
|
|
if (!isGroupV2(this.attributes)) {
|
|
return;
|
|
}
|
|
|
|
await this.modifyGroupV2({
|
|
name: 'updateAccessControlMembers',
|
|
usingCredentialsFrom: [],
|
|
createGroupChange: async () =>
|
|
window.Signal.Groups.buildAccessControlMembersChange(
|
|
this.attributes,
|
|
value
|
|
),
|
|
});
|
|
|
|
const ACCESS_ENUM = Proto.AccessControl.AccessRequired;
|
|
this.set({
|
|
accessControl: {
|
|
addFromInviteLink:
|
|
this.get('accessControl')?.addFromInviteLink || ACCESS_ENUM.MEMBER,
|
|
attributes: this.get('accessControl')?.attributes || ACCESS_ENUM.MEMBER,
|
|
members: value,
|
|
},
|
|
});
|
|
}
|
|
|
|
async updateAnnouncementsOnly(value: boolean): Promise<void> {
|
|
if (!isGroupV2(this.attributes) || !this.canBeAnnouncementGroup()) {
|
|
return;
|
|
}
|
|
|
|
await this.modifyGroupV2({
|
|
name: 'updateAnnouncementsOnly',
|
|
usingCredentialsFrom: [],
|
|
createGroupChange: async () =>
|
|
window.Signal.Groups.buildAnnouncementsOnlyChange(
|
|
this.attributes,
|
|
value
|
|
),
|
|
});
|
|
|
|
this.set({ announcementsOnly: value });
|
|
}
|
|
|
|
async updateExpirationTimer(
|
|
providedExpireTimer: DurationInSeconds | undefined,
|
|
{
|
|
reason,
|
|
receivedAt,
|
|
receivedAtMS = Date.now(),
|
|
sentAt: providedSentAt,
|
|
source: providedSource,
|
|
fromSync = false,
|
|
isInitialSync = false,
|
|
fromGroupUpdate = false,
|
|
}: {
|
|
reason: string;
|
|
receivedAt?: number;
|
|
receivedAtMS?: number;
|
|
sentAt?: number;
|
|
source?: string;
|
|
fromSync?: boolean;
|
|
isInitialSync?: boolean;
|
|
fromGroupUpdate?: boolean;
|
|
}
|
|
): Promise<boolean | null | MessageModel | void> {
|
|
const isSetByOther = providedSource || providedSentAt !== undefined;
|
|
|
|
if (isSignalConversation(this.attributes)) {
|
|
return;
|
|
}
|
|
|
|
if (isGroupV2(this.attributes)) {
|
|
if (isSetByOther) {
|
|
throw new Error(
|
|
'updateExpirationTimer: GroupV2 timers are not updated this way'
|
|
);
|
|
}
|
|
await this.modifyGroupV2({
|
|
name: 'updateExpirationTimer',
|
|
usingCredentialsFrom: [],
|
|
createGroupChange: () =>
|
|
this.updateExpirationTimerInGroupV2(providedExpireTimer),
|
|
});
|
|
return false;
|
|
}
|
|
|
|
if (!isSetByOther && this.isGroupV1AndDisabled()) {
|
|
throw new Error(
|
|
'updateExpirationTimer: GroupV1 is deprecated; cannot update expiration timer'
|
|
);
|
|
}
|
|
|
|
let expireTimer: DurationInSeconds | undefined = providedExpireTimer;
|
|
let source = providedSource;
|
|
if (this.get('left')) {
|
|
return false;
|
|
}
|
|
|
|
if (!expireTimer) {
|
|
expireTimer = undefined;
|
|
}
|
|
if (
|
|
this.get('expireTimer') === expireTimer ||
|
|
(!expireTimer && !this.get('expireTimer'))
|
|
) {
|
|
return null;
|
|
}
|
|
|
|
const logId =
|
|
`updateExpirationTimer(${this.idForLogging()}, ` +
|
|
`${expireTimer || 'disabled'}) ` +
|
|
`source=${source ?? '?'} reason=${reason}`;
|
|
|
|
log.info(`${logId}: updating`);
|
|
|
|
// if change wasn't made remotely, send it to the number/group
|
|
if (!isSetByOther) {
|
|
try {
|
|
await conversationJobQueue.add({
|
|
type: conversationQueueJobEnum.enum.DirectExpirationTimerUpdate,
|
|
conversationId: this.id,
|
|
expireTimer,
|
|
});
|
|
} catch (error) {
|
|
log.error(
|
|
`${logId}: Failed to queue expiration timer update`,
|
|
Errors.toLogFormat(error)
|
|
);
|
|
throw error;
|
|
}
|
|
}
|
|
|
|
const ourConversation =
|
|
window.ConversationController.getOurConversationOrThrow();
|
|
source = source || ourConversation.id;
|
|
const sourceServiceId = ourConversation.get('serviceId');
|
|
|
|
this.set({ expireTimer });
|
|
|
|
// This call actually removes universal timer notification and clears
|
|
// the pending flags.
|
|
await this.maybeRemoveUniversalTimer();
|
|
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
|
|
// When we add a disappearing messages notification to the conversation, we want it
|
|
// to be above the message that initiated that change, hence the subtraction.
|
|
const sentAt = (providedSentAt || receivedAtMS) - 1;
|
|
|
|
const isFromSyncOperation =
|
|
reason === 'group sync' || reason === 'contact sync';
|
|
const isFromMe =
|
|
window.ConversationController.get(source) === ourConversation;
|
|
const isNoteToSelf = isMe(this.attributes);
|
|
const shouldBeRead =
|
|
(isInitialSync && isFromSyncOperation) || isFromMe || isNoteToSelf;
|
|
|
|
const id = generateGuid();
|
|
const model = new window.Whisper.Message({
|
|
id,
|
|
conversationId: this.id,
|
|
expirationTimerUpdate: {
|
|
expireTimer,
|
|
source,
|
|
sourceServiceId,
|
|
fromSync,
|
|
fromGroupUpdate,
|
|
},
|
|
flags: Proto.DataMessage.Flags.EXPIRATION_TIMER_UPDATE,
|
|
readStatus: shouldBeRead ? ReadStatus.Read : ReadStatus.Unread,
|
|
received_at_ms: receivedAtMS,
|
|
received_at: receivedAt ?? incrementMessageCounter(),
|
|
seenStatus: shouldBeRead ? SeenStatus.Seen : SeenStatus.Unseen,
|
|
sent_at: sentAt,
|
|
type: 'timer-notification',
|
|
// TODO: DESKTOP-722
|
|
} as unknown as MessageAttributesType);
|
|
|
|
await window.Signal.Data.saveMessage(model.attributes, {
|
|
ourAci: window.textsecure.storage.user.getCheckedAci(),
|
|
forceSave: true,
|
|
});
|
|
|
|
const message = window.MessageCache.__DEPRECATED$register(
|
|
id,
|
|
model,
|
|
'updateExpirationTimer'
|
|
);
|
|
|
|
void this.addSingleMessage(message);
|
|
void this.updateUnread();
|
|
|
|
log.info(
|
|
`${logId}: added a notification received_at=${model.get('received_at')}`
|
|
);
|
|
|
|
return message;
|
|
}
|
|
|
|
isSearchable(): boolean {
|
|
return !this.get('left');
|
|
}
|
|
|
|
async markRead(
|
|
newestUnreadAt: number,
|
|
options: {
|
|
readAt?: number;
|
|
sendReadReceipts: boolean;
|
|
newestSentAt?: number;
|
|
} = {
|
|
sendReadReceipts: true,
|
|
}
|
|
): Promise<void> {
|
|
await markConversationRead(this.attributes, newestUnreadAt, options);
|
|
await this.updateUnread();
|
|
window.reduxActions.callHistory.updateCallHistoryUnreadCount();
|
|
}
|
|
|
|
async updateUnread(): Promise<void> {
|
|
const options = {
|
|
storyId: undefined,
|
|
includeStoryReplies: !isGroup(this.attributes),
|
|
};
|
|
const [unreadCount, unreadMentionsCount] = await Promise.all([
|
|
window.Signal.Data.getTotalUnreadForConversation(this.id, options),
|
|
window.Signal.Data.getTotalUnreadMentionsOfMeForConversation(
|
|
this.id,
|
|
options
|
|
),
|
|
]);
|
|
|
|
const prevUnreadCount = this.get('unreadCount');
|
|
const prevUnreadMentionsCount = this.get('unreadMentionsCount');
|
|
if (
|
|
prevUnreadCount !== unreadCount ||
|
|
prevUnreadMentionsCount !== unreadMentionsCount
|
|
) {
|
|
this.set({
|
|
unreadCount,
|
|
unreadMentionsCount,
|
|
});
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
}
|
|
}
|
|
|
|
// This is an expensive operation we use to populate the message request hero row. It
|
|
// shows groups the current user has in common with this potential new contact.
|
|
async updateSharedGroups(): Promise<void> {
|
|
if (!isDirectConversation(this.attributes)) {
|
|
return;
|
|
}
|
|
if (isMe(this.attributes)) {
|
|
return;
|
|
}
|
|
|
|
const ourAci = window.textsecure.storage.user.getCheckedAci();
|
|
const theirAci = this.getAci();
|
|
if (!theirAci) {
|
|
return;
|
|
}
|
|
|
|
const ourGroups =
|
|
await window.ConversationController.getAllGroupsInvolvingServiceId(
|
|
ourAci
|
|
);
|
|
const sharedGroups = ourGroups
|
|
.filter(c => c.hasMember(ourAci) && c.hasMember(theirAci))
|
|
.sort(
|
|
(left, right) =>
|
|
(right.get('timestamp') || 0) - (left.get('timestamp') || 0)
|
|
);
|
|
|
|
const sharedGroupNames = sharedGroups.map(conversation =>
|
|
conversation.getTitle()
|
|
);
|
|
|
|
this.set({ sharedGroupNames });
|
|
}
|
|
|
|
onChangeProfileKey(): void {
|
|
if (isDirectConversation(this.attributes)) {
|
|
drop(
|
|
this.getProfiles().catch(() => {
|
|
/* nothing to do here; logging already happened */
|
|
})
|
|
);
|
|
}
|
|
}
|
|
|
|
async getProfiles(): Promise<void> {
|
|
// request all conversation members' keys
|
|
const conversations =
|
|
this.getMembers() as unknown as Array<ConversationModel>;
|
|
|
|
await Promise.all(
|
|
conversations.map(conversation =>
|
|
getProfile(conversation.getServiceId(), conversation.get('e164'))
|
|
)
|
|
);
|
|
}
|
|
|
|
async setEncryptedProfileName(
|
|
encryptedName: string,
|
|
decryptionKey: Uint8Array
|
|
): Promise<void> {
|
|
if (!encryptedName) {
|
|
return;
|
|
}
|
|
|
|
// decrypt
|
|
const { given, family } = decryptProfileName(encryptedName, decryptionKey);
|
|
|
|
// encode
|
|
const profileName = given ? Bytes.toString(given) : undefined;
|
|
const profileFamilyName = family ? Bytes.toString(family) : undefined;
|
|
|
|
// set then check for changes
|
|
const oldName = this.getProfileName();
|
|
const hadPreviousName = Boolean(oldName);
|
|
this.set({ profileName, profileFamilyName });
|
|
|
|
const newName = this.getProfileName();
|
|
|
|
// Note that we compare the combined names to ensure that we don't present the exact
|
|
// same before/after string, even if someone is moving from just first name to
|
|
// first/last name in their profile data.
|
|
const nameChanged = oldName !== newName;
|
|
if (!isMe(this.attributes) && hadPreviousName && nameChanged) {
|
|
const change = {
|
|
type: 'name',
|
|
oldName,
|
|
newName,
|
|
};
|
|
|
|
await this.addProfileChange(change);
|
|
}
|
|
}
|
|
|
|
async setProfileAvatar(
|
|
avatarPath: undefined | null | string,
|
|
decryptionKey: Uint8Array
|
|
): Promise<void> {
|
|
if (isMe(this.attributes)) {
|
|
if (avatarPath) {
|
|
await window.storage.put('avatarUrl', avatarPath);
|
|
} else {
|
|
await window.storage.remove('avatarUrl');
|
|
}
|
|
}
|
|
|
|
if (!avatarPath) {
|
|
this.set({ profileAvatar: undefined });
|
|
return;
|
|
}
|
|
|
|
const { messaging } = window.textsecure;
|
|
if (!messaging) {
|
|
throw new Error('setProfileAvatar: Cannot fetch avatar when offline!');
|
|
}
|
|
const avatar = await messaging.getAvatar(avatarPath);
|
|
|
|
// decrypt
|
|
const decrypted = decryptProfile(avatar, decryptionKey);
|
|
|
|
// update the conversation avatar only if hash differs
|
|
if (decrypted) {
|
|
const newAttributes = await Conversation.maybeUpdateProfileAvatar(
|
|
this.attributes,
|
|
{
|
|
data: decrypted,
|
|
writeNewAttachmentData,
|
|
deleteAttachmentData,
|
|
doesAttachmentExist,
|
|
}
|
|
);
|
|
this.set(newAttributes);
|
|
}
|
|
}
|
|
|
|
async setProfileKey(
|
|
profileKey: string | undefined,
|
|
{ viaStorageServiceSync = false } = {}
|
|
): Promise<boolean> {
|
|
const oldProfileKey = this.get('profileKey');
|
|
|
|
// profileKey is a string so we can compare it directly
|
|
if (oldProfileKey === profileKey) {
|
|
return false;
|
|
}
|
|
|
|
log.info(
|
|
`Setting sealedSender to UNKNOWN for conversation ${this.idForLogging()}`
|
|
);
|
|
this.set({
|
|
profileKeyCredential: null,
|
|
profileKeyCredentialExpiration: null,
|
|
accessKey: null,
|
|
sealedSender: SEALED_SENDER.UNKNOWN,
|
|
});
|
|
|
|
// We messaged the contact when it had either phone number or username
|
|
// title.
|
|
if (this.get('needsTitleTransition')) {
|
|
log.info(
|
|
`setProfileKey(${this.idForLogging()}): adding a ` +
|
|
'title transition notification'
|
|
);
|
|
|
|
const { type, e164, username } = this.attributes;
|
|
|
|
this.unset('needsTitleTransition');
|
|
|
|
await this.addNotification('title-transition-notification', {
|
|
readStatus: ReadStatus.Read,
|
|
seenStatus: SeenStatus.Unseen,
|
|
titleTransition: {
|
|
renderInfo: {
|
|
type,
|
|
e164,
|
|
username,
|
|
},
|
|
},
|
|
});
|
|
}
|
|
|
|
// Don't trigger immediate profile fetches when syncing to remote storage
|
|
this.set({ profileKey }, { silent: viaStorageServiceSync });
|
|
|
|
// If our profile key was cleared above, we don't tell our linked devices about it.
|
|
// We want linked devices to tell us what it should be, instead of telling them to
|
|
// erase their local value.
|
|
if (!viaStorageServiceSync && profileKey) {
|
|
this.captureChange('profileKey');
|
|
}
|
|
|
|
this.deriveAccessKeyIfNeeded();
|
|
|
|
// We will update the conversation during storage service sync
|
|
if (!viaStorageServiceSync) {
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
hasProfileKeyCredentialExpired(): boolean {
|
|
const profileKey = this.get('profileKey');
|
|
if (!profileKey) {
|
|
return false;
|
|
}
|
|
|
|
const profileKeyCredential = this.get('profileKeyCredential');
|
|
const profileKeyCredentialExpiration = this.get(
|
|
'profileKeyCredentialExpiration'
|
|
);
|
|
|
|
if (!profileKeyCredential) {
|
|
return true;
|
|
}
|
|
|
|
if (!isNumber(profileKeyCredentialExpiration)) {
|
|
const logId = this.idForLogging();
|
|
log.warn(`hasProfileKeyCredentialExpired(${logId}): missing expiration`);
|
|
return true;
|
|
}
|
|
|
|
const today = toDayMillis(Date.now());
|
|
|
|
return profileKeyCredentialExpiration <= today;
|
|
}
|
|
|
|
deriveAccessKeyIfNeeded(): void {
|
|
const profileKey = this.get('profileKey');
|
|
if (!profileKey) {
|
|
return;
|
|
}
|
|
if (this.get('accessKey')) {
|
|
return;
|
|
}
|
|
|
|
const profileKeyBuffer = Bytes.fromBase64(profileKey);
|
|
const accessKeyBuffer = deriveAccessKey(profileKeyBuffer);
|
|
const accessKey = Bytes.toBase64(accessKeyBuffer);
|
|
this.set({ accessKey });
|
|
}
|
|
|
|
deriveProfileKeyVersion(): string | undefined {
|
|
const profileKey = this.get('profileKey');
|
|
if (!profileKey) {
|
|
return;
|
|
}
|
|
|
|
const serviceId = this.getServiceId();
|
|
if (!serviceId) {
|
|
return;
|
|
}
|
|
|
|
const lastProfile = this.get('lastProfile');
|
|
if (lastProfile?.profileKey === profileKey) {
|
|
return lastProfile.profileKeyVersion;
|
|
}
|
|
|
|
const profileKeyVersion = deriveProfileKeyVersion(profileKey, serviceId);
|
|
if (!profileKeyVersion) {
|
|
log.warn(
|
|
'deriveProfileKeyVersion: Failed to derive profile key version, ' +
|
|
'clearing profile key.'
|
|
);
|
|
void this.setProfileKey(undefined);
|
|
return;
|
|
}
|
|
|
|
return profileKeyVersion;
|
|
}
|
|
|
|
async updateLastProfile(
|
|
oldValue: ConversationLastProfileType | undefined,
|
|
{ profileKey, profileKeyVersion }: ConversationLastProfileType
|
|
): Promise<void> {
|
|
const lastProfile = this.get('lastProfile');
|
|
|
|
// Atomic updates only
|
|
if (lastProfile !== oldValue) {
|
|
return;
|
|
}
|
|
|
|
if (
|
|
lastProfile?.profileKey === profileKey &&
|
|
lastProfile?.profileKeyVersion === profileKeyVersion
|
|
) {
|
|
return;
|
|
}
|
|
|
|
log.warn(
|
|
'ConversationModel.updateLastProfile: updating for',
|
|
this.idForLogging()
|
|
);
|
|
|
|
this.set({ lastProfile: { profileKey, profileKeyVersion } });
|
|
|
|
await window.Signal.Data.updateConversation(this.attributes);
|
|
}
|
|
|
|
async removeLastProfile(
|
|
oldValue: ConversationLastProfileType | undefined
|
|
): Promise<void> {
|
|
// Atomic updates only
|
|
if (this.get('lastProfile') !== oldValue) {
|
|
return;
|
|
}
|
|
|
|
log.warn(
|
|
'ConversationModel.removeLastProfile: called for',
|
|
this.idForLogging()
|
|
);
|
|
|
|
this.set({
|
|
lastProfile: undefined,
|
|
|
|
// We don't have any knowledge of profile anymore. Drop all associated
|
|
// data.
|
|
about: undefined,
|
|
aboutEmoji: undefined,
|
|
profileAvatar: undefined,
|
|
});
|
|
|
|
await window.Signal.Data.updateConversation(this.attributes);
|
|
}
|
|
|
|
hasMember(serviceId: ServiceIdString): boolean {
|
|
const members = this.getMembers();
|
|
|
|
return members.some(member => member.getServiceId() === serviceId);
|
|
}
|
|
|
|
fetchContacts(): void {
|
|
const members = this.getMembers();
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
|
|
this.contactCollection!.reset(members);
|
|
}
|
|
|
|
async destroyMessages(): Promise<void> {
|
|
this.set({
|
|
lastMessage: null,
|
|
lastMessageAuthor: null,
|
|
timestamp: null,
|
|
active_at: null,
|
|
pendingUniversalTimer: undefined,
|
|
});
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
|
|
await window.Signal.Data.removeAllMessagesInConversation(this.id, {
|
|
logId: this.idForLogging(),
|
|
});
|
|
}
|
|
|
|
getTitle(options?: { isShort?: boolean }): string {
|
|
return getTitle(this.attributes, options);
|
|
}
|
|
|
|
getTitleNoDefault(options?: { isShort?: boolean }): string | undefined {
|
|
return getTitleNoDefault(this.attributes, options);
|
|
}
|
|
|
|
getProfileName(): string | undefined {
|
|
return getProfileName(this.attributes);
|
|
}
|
|
|
|
getNumber(): string | undefined {
|
|
return getNumber(this.attributes);
|
|
}
|
|
|
|
getColor(): AvatarColorType {
|
|
return migrateColor(this.getServiceId(), this.get('color'));
|
|
}
|
|
|
|
getConversationColor(): ConversationColorType | undefined {
|
|
return this.get('conversationColor');
|
|
}
|
|
|
|
getCustomColorData(): {
|
|
customColor?: CustomColorType;
|
|
customColorId?: string;
|
|
} {
|
|
if (this.getConversationColor() !== 'custom') {
|
|
return {
|
|
customColor: undefined,
|
|
customColorId: undefined,
|
|
};
|
|
}
|
|
|
|
return {
|
|
customColor: this.get('customColor'),
|
|
customColorId: this.get('customColorId'),
|
|
};
|
|
}
|
|
|
|
unblurAvatar(): void {
|
|
const avatarPath = getAvatarPath(this.attributes);
|
|
if (avatarPath) {
|
|
this.set('unblurredAvatarPath', avatarPath);
|
|
} else {
|
|
this.unset('unblurredAvatarPath');
|
|
}
|
|
}
|
|
|
|
areWeAdmin(): boolean {
|
|
return areWeAdmin(this.attributes);
|
|
}
|
|
|
|
// Set of items to captureChanges on:
|
|
// [-] serviceId
|
|
// [-] e164
|
|
// [X] profileKey
|
|
// [-] identityKey
|
|
// [X] verified!
|
|
// [-] profileName
|
|
// [-] profileFamilyName
|
|
// [X] nicknameAndNote
|
|
// [X] blocked
|
|
// [X] whitelisted
|
|
// [X] archived
|
|
// [X] markedUnread
|
|
// [X] dontNotifyForMentionsIfMuted
|
|
// [x] firstUnregisteredAt
|
|
captureChange(logMessage: string): void {
|
|
if (isSignalConversation(this.attributes)) {
|
|
return;
|
|
}
|
|
|
|
log.info('storageService[captureChange]', logMessage, this.idForLogging());
|
|
this.set({ needsStorageServiceSync: true });
|
|
|
|
void this.queueJob('captureChange', async () => {
|
|
storageServiceUploadJob();
|
|
});
|
|
}
|
|
|
|
startMuteTimer({ viaStorageServiceSync = false } = {}): void {
|
|
clearTimeoutIfNecessary(this.muteTimer);
|
|
this.muteTimer = undefined;
|
|
|
|
const muteExpiresAt = this.get('muteExpiresAt');
|
|
if (isNumber(muteExpiresAt) && muteExpiresAt < Number.MAX_SAFE_INTEGER) {
|
|
const delay = muteExpiresAt - Date.now();
|
|
if (delay <= 0) {
|
|
this.setMuteExpiration(0, { viaStorageServiceSync });
|
|
return;
|
|
}
|
|
|
|
this.muteTimer = setTimeout(() => this.setMuteExpiration(0), delay);
|
|
}
|
|
}
|
|
|
|
toggleHideStories(): void {
|
|
const hideStory = !this.get('hideStory');
|
|
log.info(
|
|
`toggleHideStories(${this.idForLogging()}): newValue=${hideStory}`
|
|
);
|
|
this.set({ hideStory });
|
|
this.captureChange('hideStory');
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
}
|
|
|
|
setMuteExpiration(
|
|
muteExpiresAt = 0,
|
|
{ viaStorageServiceSync = false } = {}
|
|
): void {
|
|
const prevExpiration = this.get('muteExpiresAt');
|
|
|
|
if (prevExpiration === muteExpiresAt) {
|
|
return;
|
|
}
|
|
|
|
this.set({ muteExpiresAt });
|
|
|
|
// Don't cause duplicate captureChange
|
|
this.startMuteTimer({ viaStorageServiceSync: true });
|
|
|
|
if (!viaStorageServiceSync) {
|
|
this.captureChange('mutedUntilTimestamp');
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
}
|
|
}
|
|
|
|
isMuted(): boolean {
|
|
return isConversationMuted(this.attributes);
|
|
}
|
|
|
|
async notify(
|
|
message: Readonly<MessageModel>,
|
|
reaction?: Readonly<ReactionAttributesType>
|
|
): Promise<void> {
|
|
// As a performance optimization don't perform any work if notifications are
|
|
// disabled.
|
|
if (!notificationService.isEnabled) {
|
|
return;
|
|
}
|
|
|
|
if (this.isMuted()) {
|
|
if (this.get('dontNotifyForMentionsIfMuted')) {
|
|
return;
|
|
}
|
|
|
|
const ourAci = window.textsecure.storage.user.getCheckedAci();
|
|
const ourPni = window.textsecure.storage.user.getCheckedPni();
|
|
const ourServiceIds: Set<ServiceIdString> = new Set([ourAci, ourPni]);
|
|
|
|
const mentionsMe = (message.get('bodyRanges') || []).some(bodyRange => {
|
|
if (!BodyRange.isMention(bodyRange)) {
|
|
return false;
|
|
}
|
|
return ourServiceIds.has(
|
|
normalizeServiceId(bodyRange.mentionAci, 'notify: mentionsMe check')
|
|
);
|
|
});
|
|
if (!mentionsMe) {
|
|
return;
|
|
}
|
|
}
|
|
|
|
if (!isIncoming(message.attributes) && !reaction) {
|
|
return;
|
|
}
|
|
|
|
const conversationId = this.id;
|
|
const isMessageInDirectConversation = isDirectConversation(this.attributes);
|
|
|
|
const sender = reaction
|
|
? window.ConversationController.get(reaction.fromId)
|
|
: getAuthor(message.attributes);
|
|
const senderName = sender
|
|
? sender.getTitle()
|
|
: window.i18n('icu:unknownContact');
|
|
const senderTitle = isMessageInDirectConversation
|
|
? senderName
|
|
: window.i18n('icu:notificationSenderInGroup', {
|
|
sender: senderName,
|
|
group: this.getTitle(),
|
|
});
|
|
|
|
const { url, absolutePath } = await this.getAvatarOrIdenticon();
|
|
|
|
const messageJSON = message.toJSON();
|
|
const messageId = message.id;
|
|
const isExpiringMessage = Message.hasExpiration(messageJSON);
|
|
|
|
notificationService.add({
|
|
senderTitle,
|
|
conversationId,
|
|
storyId: isMessageInDirectConversation
|
|
? undefined
|
|
: message.get('storyId'),
|
|
notificationIconUrl: url,
|
|
notificationIconAbsolutePath: absolutePath,
|
|
isExpiringMessage,
|
|
message: message.getNotificationText(),
|
|
messageId,
|
|
reaction: reaction
|
|
? {
|
|
emoji: reaction.emoji,
|
|
targetAuthorAci: reaction.targetAuthorAci,
|
|
targetTimestamp: reaction.targetTimestamp,
|
|
}
|
|
: undefined,
|
|
sentAt: message.get('timestamp'),
|
|
type: reaction ? NotificationType.Reaction : NotificationType.Message,
|
|
});
|
|
}
|
|
|
|
async getAvatarOrIdenticon(): Promise<{
|
|
url: string;
|
|
absolutePath?: string;
|
|
}> {
|
|
const avatarPath = getAvatarPath(this.attributes);
|
|
if (avatarPath) {
|
|
return {
|
|
url: getAbsoluteAttachmentPath(avatarPath),
|
|
absolutePath: getAbsoluteAttachmentPath(avatarPath),
|
|
};
|
|
}
|
|
|
|
const { url, path } = await this.getIdenticon({
|
|
saveToDisk: OS.isWindows(),
|
|
});
|
|
return {
|
|
url,
|
|
absolutePath: path ? getAbsoluteTempPath(path) : undefined,
|
|
};
|
|
}
|
|
|
|
private async getIdenticon({
|
|
saveToDisk,
|
|
}: { saveToDisk?: boolean } = {}): Promise<{
|
|
url: string;
|
|
path?: string;
|
|
}> {
|
|
const isContact = isDirectConversation(this.attributes);
|
|
const color = this.getColor();
|
|
const title = this.getTitle();
|
|
|
|
if (isContact) {
|
|
const text = (title && getInitials(title)) || '#';
|
|
|
|
const cached = this.cachedIdenticon;
|
|
if (cached && cached.text === text && cached.color === color) {
|
|
return { ...cached };
|
|
}
|
|
|
|
const { url, path } = await createIdenticon(
|
|
color,
|
|
{
|
|
type: 'contact',
|
|
text,
|
|
},
|
|
{
|
|
saveToDisk,
|
|
}
|
|
);
|
|
|
|
this.cachedIdenticon = { text, color, url, path };
|
|
return { url, path };
|
|
}
|
|
|
|
const cached = this.cachedIdenticon;
|
|
if (cached && cached.color === color) {
|
|
return { ...cached };
|
|
}
|
|
|
|
const { url, path } = await createIdenticon(
|
|
color,
|
|
{ type: 'group' },
|
|
{
|
|
saveToDisk,
|
|
}
|
|
);
|
|
|
|
this.cachedIdenticon = { color, url, path };
|
|
return { url, path };
|
|
}
|
|
|
|
notifyTyping(options: {
|
|
isTyping: boolean;
|
|
senderId: string;
|
|
fromMe: boolean;
|
|
senderDevice: number;
|
|
}): void {
|
|
const { isTyping, senderId, fromMe, senderDevice } = options;
|
|
|
|
// We don't do anything with typing messages from our other devices
|
|
if (fromMe) {
|
|
return;
|
|
}
|
|
|
|
const sender = window.ConversationController.get(senderId);
|
|
if (!sender) {
|
|
return;
|
|
}
|
|
|
|
const senderServiceId = sender.getServiceId();
|
|
if (!senderServiceId) {
|
|
return;
|
|
}
|
|
|
|
// Drop typing indicators for announcement only groups where the sender
|
|
// is not an admin
|
|
if (this.get('announcementsOnly') && !this.isAdmin(senderServiceId)) {
|
|
return;
|
|
}
|
|
|
|
const typingToken = `${sender.id}.${senderDevice}`;
|
|
|
|
this.contactTypingTimers = this.contactTypingTimers || {};
|
|
const record = this.contactTypingTimers[typingToken];
|
|
|
|
if (record) {
|
|
clearTimeout(record.timer);
|
|
}
|
|
|
|
if (isTyping) {
|
|
this.contactTypingTimers[typingToken] = this.contactTypingTimers[
|
|
typingToken
|
|
] || {
|
|
timestamp: Date.now(),
|
|
senderId,
|
|
senderDevice,
|
|
};
|
|
|
|
this.contactTypingTimers[typingToken].timer = setTimeout(
|
|
this.clearContactTypingTimer.bind(this, typingToken),
|
|
15 * 1000
|
|
);
|
|
// User was not previously typing before. State change!
|
|
if (!record) {
|
|
this.trigger('change', this, { force: true });
|
|
}
|
|
} else {
|
|
delete this.contactTypingTimers[typingToken];
|
|
if (record) {
|
|
// User was previously typing, and is no longer. State change!
|
|
this.trigger('change', this, { force: true });
|
|
}
|
|
}
|
|
}
|
|
|
|
clearContactTypingTimer(typingToken: string): void {
|
|
this.contactTypingTimers = this.contactTypingTimers || {};
|
|
const record = this.contactTypingTimers[typingToken];
|
|
|
|
if (record) {
|
|
clearTimeout(record.timer);
|
|
delete this.contactTypingTimers[typingToken];
|
|
|
|
// User was previously typing, but timed out or we received message. State change!
|
|
this.trigger('change', this, { force: true });
|
|
}
|
|
}
|
|
|
|
pin(): void {
|
|
if (this.get('isPinned')) {
|
|
return;
|
|
}
|
|
|
|
const validationError = this.validate();
|
|
if (validationError) {
|
|
log.error(
|
|
`not pinning ${this.idForLogging()} because of ` +
|
|
`validation error ${validationError}`
|
|
);
|
|
return;
|
|
}
|
|
|
|
log.info('pinning', this.idForLogging());
|
|
const pinnedConversationIds = new Set(
|
|
window.storage.get('pinnedConversationIds', new Array<string>())
|
|
);
|
|
|
|
pinnedConversationIds.add(this.id);
|
|
|
|
this.writePinnedConversations([...pinnedConversationIds]);
|
|
|
|
this.set('isPinned', true);
|
|
|
|
if (this.get('isArchived')) {
|
|
this.set({ isArchived: false });
|
|
}
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
}
|
|
|
|
unpin(): void {
|
|
if (!this.get('isPinned')) {
|
|
return;
|
|
}
|
|
|
|
log.info('un-pinning', this.idForLogging());
|
|
|
|
const pinnedConversationIds = new Set(
|
|
window.storage.get('pinnedConversationIds', new Array<string>())
|
|
);
|
|
|
|
pinnedConversationIds.delete(this.id);
|
|
|
|
this.writePinnedConversations([...pinnedConversationIds]);
|
|
|
|
this.set('isPinned', false);
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
}
|
|
|
|
writePinnedConversations(pinnedConversationIds: Array<string>): void {
|
|
drop(window.storage.put('pinnedConversationIds', pinnedConversationIds));
|
|
|
|
const myId = window.ConversationController.getOurConversationId();
|
|
const me = window.ConversationController.get(myId);
|
|
|
|
if (me) {
|
|
me.captureChange('pin');
|
|
}
|
|
}
|
|
|
|
setDontNotifyForMentionsIfMuted(newValue: boolean): void {
|
|
const previousValue = Boolean(this.get('dontNotifyForMentionsIfMuted'));
|
|
if (previousValue === newValue) {
|
|
return;
|
|
}
|
|
|
|
this.set({ dontNotifyForMentionsIfMuted: newValue });
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
this.captureChange('dontNotifyForMentionsIfMuted');
|
|
}
|
|
|
|
acknowledgeGroupMemberNameCollisions(
|
|
groupNameCollisions: ReadonlyDeep<GroupNameCollisionsWithIdsByTitle>
|
|
): void {
|
|
this.set('acknowledgedGroupNameCollisions', groupNameCollisions);
|
|
window.Signal.Data.updateConversation(this.attributes);
|
|
}
|
|
|
|
onOpenStart(): void {
|
|
log.info(`conversation ${this.idForLogging()} open start`);
|
|
window.ConversationController.onConvoOpenStart(this.id);
|
|
}
|
|
|
|
onOpenComplete(startedAt: number): void {
|
|
const now = Date.now();
|
|
const delta = now - startedAt;
|
|
|
|
log.info(`conversation ${this.idForLogging()} open took ${delta}ms`);
|
|
window.SignalCI?.handleEvent('conversation:open', { delta });
|
|
}
|
|
|
|
async flushDebouncedUpdates(): Promise<void> {
|
|
try {
|
|
this.debouncedUpdateLastMessage.flush();
|
|
} catch (error) {
|
|
const logId = this.idForLogging();
|
|
log.error(
|
|
`flushDebouncedUpdates(${logId}): got error`,
|
|
Errors.toLogFormat(error)
|
|
);
|
|
}
|
|
}
|
|
|
|
getPniSignatureMessage(): PniSignatureMessageType | undefined {
|
|
if (!this.get('shareMyPhoneNumber')) {
|
|
return undefined;
|
|
}
|
|
return window.textsecure.storage.protocol.signAlternateIdentity();
|
|
}
|
|
|
|
/** @return only undefined if not a group */
|
|
getStorySendMode(): StorySendMode | undefined {
|
|
// isDirectConversation is used instead of isGroup because this is what
|
|
// used in `format()` when sending conversation "type" to redux.
|
|
if (isDirectConversation(this.attributes)) {
|
|
return undefined;
|
|
}
|
|
|
|
return this.getGroupStorySendMode();
|
|
}
|
|
|
|
private getGroupStorySendMode(): StorySendMode {
|
|
strictAssert(
|
|
!isDirectConversation(this.attributes),
|
|
'Must be a group to have send story mode'
|
|
);
|
|
|
|
return this.get('storySendMode') ?? StorySendMode.IfActive;
|
|
}
|
|
|
|
async shutdownJobQueue(): Promise<void> {
|
|
log.info(`conversation ${this.idForLogging()} jobQueue shutdown start`);
|
|
|
|
if (!this.jobQueue) {
|
|
log.info(`conversation ${this.idForLogging()} no jobQueue to shutdown`);
|
|
return;
|
|
}
|
|
|
|
// If the queue takes more than 10 seconds to get to idle, we force it by setting
|
|
// isShuttingDown = true which will reject incoming requests.
|
|
const to = setTimeout(() => {
|
|
log.warn(
|
|
`conversation ${this.idForLogging()} jobQueue stop accepting new work`
|
|
);
|
|
this.isShuttingDown = true;
|
|
}, 10 * SECOND);
|
|
|
|
await this.jobQueue.onIdle();
|
|
this.isShuttingDown = true;
|
|
clearTimeout(to);
|
|
|
|
log.info(`conversation ${this.idForLogging()} jobQueue shutdown complete`);
|
|
}
|
|
}
|
|
|
|
window.Whisper.Conversation = ConversationModel;
|
|
|
|
window.Whisper.ConversationCollection = window.Backbone.Collection.extend({
|
|
model: window.Whisper.Conversation,
|
|
|
|
/**
|
|
* window.Backbone defines a `_byId` field. Here we set up additional `_byE164`,
|
|
* `_byServiceId`, and `_byGroupId` fields so we can track conversations by more
|
|
* than just their id.
|
|
*/
|
|
initialize() {
|
|
this.eraseLookups();
|
|
this.on(
|
|
'idUpdated',
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
(model: ConversationModel, idProp: string, oldValue: any) => {
|
|
if (oldValue) {
|
|
if (idProp === 'e164') {
|
|
delete this._byE164[oldValue];
|
|
}
|
|
if (idProp === 'serviceId') {
|
|
delete this._byServiceId[oldValue];
|
|
}
|
|
if (idProp === 'pni') {
|
|
delete this._byPni[oldValue];
|
|
}
|
|
if (idProp === 'groupId') {
|
|
delete this._byGroupId[oldValue];
|
|
}
|
|
}
|
|
const e164 = model.get('e164');
|
|
if (e164) {
|
|
this._byE164[e164] = model;
|
|
}
|
|
const serviceId = model.getServiceId();
|
|
if (serviceId) {
|
|
this._byServiceId[serviceId] = model;
|
|
}
|
|
const pni = model.getPni();
|
|
if (pni) {
|
|
this._byPni[pni] = model;
|
|
}
|
|
const groupId = model.get('groupId');
|
|
if (groupId) {
|
|
this._byGroupId[groupId] = model;
|
|
}
|
|
}
|
|
);
|
|
},
|
|
|
|
reset(models?: Array<ConversationModel>, options?: Backbone.Silenceable) {
|
|
window.Backbone.Collection.prototype.reset.call(this, models, options);
|
|
this.resetLookups();
|
|
},
|
|
|
|
resetLookups() {
|
|
this.eraseLookups();
|
|
this.generateLookups(this.models);
|
|
},
|
|
|
|
generateLookups(models: ReadonlyArray<ConversationModel>) {
|
|
models.forEach(model => {
|
|
const e164 = model.get('e164');
|
|
if (e164) {
|
|
const existing = this._byE164[e164];
|
|
|
|
// Prefer the contact with both e164 and serviceId
|
|
if (!existing || (existing && !existing.getServiceId())) {
|
|
this._byE164[e164] = model;
|
|
}
|
|
}
|
|
|
|
const serviceId = model.getServiceId();
|
|
if (serviceId) {
|
|
const existing = this._byServiceId[serviceId];
|
|
|
|
// Prefer the contact with both e164 and seviceId
|
|
if (!existing || (existing && !existing.get('e164'))) {
|
|
this._byServiceId[serviceId] = model;
|
|
}
|
|
}
|
|
|
|
const pni = model.getPni();
|
|
if (pni) {
|
|
const existing = this._byPni[pni];
|
|
|
|
// Prefer the contact with both serviceId and pni
|
|
if (!existing || (existing && !existing.getServiceId())) {
|
|
this._byPni[pni] = model;
|
|
}
|
|
}
|
|
|
|
const groupId = model.get('groupId');
|
|
if (groupId) {
|
|
this._byGroupId[groupId] = model;
|
|
}
|
|
});
|
|
},
|
|
|
|
eraseLookups() {
|
|
this._byE164 = Object.create(null);
|
|
this._byServiceId = Object.create(null);
|
|
this._byPni = Object.create(null);
|
|
this._byGroupId = Object.create(null);
|
|
},
|
|
|
|
add(
|
|
data:
|
|
| ConversationModel
|
|
| ConversationAttributesType
|
|
| Array<ConversationModel>
|
|
| Array<ConversationAttributesType>
|
|
) {
|
|
let hydratedData: Array<ConversationModel> | ConversationModel;
|
|
|
|
// First, we need to ensure that the data we're working with is Conversation models
|
|
if (Array.isArray(data)) {
|
|
hydratedData = [];
|
|
for (let i = 0, max = data.length; i < max; i += 1) {
|
|
const item = data[i];
|
|
|
|
// We create a new model if it's not already a model
|
|
if (has(item, 'get')) {
|
|
hydratedData.push(item as ConversationModel);
|
|
} else {
|
|
hydratedData.push(
|
|
new window.Whisper.Conversation(item as ConversationAttributesType)
|
|
);
|
|
}
|
|
}
|
|
} else if (has(data, 'get')) {
|
|
hydratedData = data as ConversationModel;
|
|
} else {
|
|
hydratedData = new window.Whisper.Conversation(
|
|
data as ConversationAttributesType
|
|
);
|
|
}
|
|
|
|
// Next, we update our lookups first to prevent infinite loops on the 'add' event
|
|
this.generateLookups(
|
|
Array.isArray(hydratedData) ? hydratedData : [hydratedData]
|
|
);
|
|
|
|
// Lastly, we fire off the add events related to this change
|
|
// Go home Backbone, you're drunk.
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
window.Backbone.Collection.prototype.add.call(this, hydratedData as any);
|
|
|
|
return hydratedData;
|
|
},
|
|
|
|
/**
|
|
* window.Backbone collections have a `_byId` field that `get` defers to. Here, we
|
|
* override `get` to first access our custom `_byE164`, `_byServiceId`, and
|
|
* `_byGroupId` functions, followed by falling back to the original
|
|
* window.Backbone implementation.
|
|
*/
|
|
get(id: string) {
|
|
return (
|
|
this._byE164[id] ||
|
|
this._byE164[`+${id}`] ||
|
|
this._byServiceId[id] ||
|
|
this._byPni[id] ||
|
|
this._byGroupId[id] ||
|
|
window.Backbone.Collection.prototype.get.call(this, id)
|
|
);
|
|
},
|
|
|
|
comparator(m: ConversationModel) {
|
|
return -(m.get('active_at') || 0);
|
|
},
|
|
});
|