signal-desktop/ts/state/ducks/composer.ts

1543 lines
41 KiB
TypeScript
Raw Normal View History

2023-01-03 19:55:46 +00:00
// Copyright 2021 Signal Messenger, LLC
2021-06-25 16:08:16 +00:00
// SPDX-License-Identifier: AGPL-3.0-only
import path from 'path';
import { debounce, isEqual } from 'lodash';
import type { ThunkAction, ThunkDispatch } from 'redux-thunk';
2021-08-09 20:06:21 +00:00
import type { ReadonlyDeep } from 'type-fest';
import type {
2022-12-08 07:43:48 +00:00
AddLinkPreviewActionType,
RemoveLinkPreviewActionType,
} from './linkPreviews';
import type {
AttachmentType,
AttachmentDraftType,
InMemoryAttachmentDraftType,
} from '../../types/Attachment';
import type { BoundActionCreatorsMapObject } from '../../hooks/useBoundActions';
import type { DraftBodyRanges } from '../../types/BodyRange';
2023-06-14 22:00:30 +00:00
import { BodyRange } from '../../types/BodyRange';
2022-12-08 07:43:48 +00:00
import type { LinkPreviewType } from '../../types/message/LinkPreviews';
import type { MessageAttributesType } from '../../model-types.d';
import type { NoopActionType } from './noop';
import type { ShowToastActionType } from './toast';
import type { StateType as RootStateType } from '../reducer';
import type { UUIDStringType } from '../../types/UUID';
import * as log from '../../logging/log';
import * as Errors from '../../types/errors';
2022-06-17 00:48:57 +00:00
import {
ADD_PREVIEW as ADD_LINK_PREVIEW,
REMOVE_PREVIEW as REMOVE_LINK_PREVIEW,
} from './linkPreviews';
import { LinkPreviewSourceType } from '../../types/LinkPreview';
2023-03-02 20:55:40 +00:00
import { completeRecording } from './audioRecorder';
2023-01-21 00:31:30 +00:00
import { RecordingState } from '../../types/AudioRecorder';
import { SHOW_TOAST } from './toast';
import type { AnyToast } from '../../types/Toast';
import { ToastType } from '../../types/Toast';
2022-12-08 07:43:48 +00:00
import { SafetyNumberChangeSource } from '../../components/SafetyNumberChangeDialog';
import { UUID } from '../../types/UUID';
import { assignWithNoUnnecessaryAllocation } from '../../util/assignWithNoUnnecessaryAllocation';
import { blockSendUntilConversationsAreVerified } from '../../util/blockSendUntilConversationsAreVerified';
import { clearConversationDraftAttachments } from '../../util/clearConversationDraftAttachments';
import { deleteDraftAttachment } from '../../util/deleteDraftAttachment';
import {
getLinkPreviewForSend,
hasLinkPreviewLoaded,
maybeGrabLinkPreview,
removeLinkPreview,
2022-12-08 07:43:48 +00:00
resetLinkPreview,
suspendLinkPreviews,
2022-12-08 07:43:48 +00:00
} from '../../services/LinkPreview';
import {
getMaximumAttachmentSizeInKb,
getRenderDetailsForLimit,
KIBIBYTE,
} from '../../types/AttachmentSize';
import { getValue as getRemoteConfigValue } from '../../RemoteConfig';
import { getRecipientsByConversation } from '../../util/getRecipientsByConversation';
import { processAttachment } from '../../util/processAttachment';
2022-12-08 07:43:48 +00:00
import { hasDraftAttachments } from '../../util/hasDraftAttachments';
import { isFileDangerous } from '../../util/isFileDangerous';
import { isImage, isVideo, stringToMIMEType } from '../../types/MIME';
import { isNotNil } from '../../util/isNotNil';
import { replaceIndex } from '../../util/replaceIndex';
import { resolveAttachmentDraftData } from '../../util/resolveAttachmentDraftData';
import { resolveDraftAttachmentOnDisk } from '../../util/resolveDraftAttachmentOnDisk';
import { shouldShowInvalidMessageToast } from '../../util/shouldShowInvalidMessageToast';
import { writeDraftAttachment } from '../../util/writeDraftAttachment';
import { getMessageById } from '../../messages/getMessageById';
import { canReply } from '../selectors/message';
import { getContactId } from '../../messages/helpers';
import { getConversationSelector } from '../selectors/conversations';
import { enqueueReactionForSend } from '../../reactions/enqueueReactionForSend';
import { useBoundActions } from '../../hooks/useBoundActions';
import {
CONVERSATION_UNLOADED,
2023-03-20 22:23:53 +00:00
TARGETED_CONVERSATION_CHANGED,
scrollToMessage,
} from './conversations';
import type {
ConversationUnloadedActionType,
2023-03-20 22:23:53 +00:00
TargetedConversationChangedActionType,
ScrollToMessageActionType,
} from './conversations';
import { longRunningTaskWrapper } from '../../util/longRunningTaskWrapper';
2023-01-03 22:35:59 +00:00
import { drop } from '../../util/drop';
import { strictAssert } from '../../util/assert';
2023-03-27 23:48:57 +00:00
import { makeQuote } from '../../util/makeQuote';
import { sendEditedMessage as doSendEditedMessage } from '../../util/sendEditedMessage';
import { maybeBlockSendForFormattingModal } from '../../util/maybeBlockSendForFormattingModal';
import { maybeBlockSendForEditWarningModal } from '../../util/maybeBlockSendForEditWarningModal';
import { Sound, SoundType } from '../../util/Sound';
2021-06-25 16:08:16 +00:00
// State
// eslint-disable-next-line local-rules/type-alias-readonlydeep
type ComposerStateByConversationType = {
attachments: ReadonlyArray<AttachmentDraftType>;
focusCounter: number;
2022-12-08 07:43:48 +00:00
isDisabled: boolean;
2021-06-25 16:08:16 +00:00
linkPreviewLoading: boolean;
2022-06-17 00:48:57 +00:00
linkPreviewResult?: LinkPreviewType;
2022-12-08 07:43:48 +00:00
messageCompositionId: UUIDStringType;
2021-06-25 16:08:16 +00:00
quotedMessage?: Pick<MessageAttributesType, 'conversationId' | 'quote'>;
sendCounter: number;
shouldSendHighQualityAttachments?: boolean;
2021-06-25 16:08:16 +00:00
};
// eslint-disable-next-line local-rules/type-alias-readonlydeep
export type QuotedMessageType = Pick<
MessageAttributesType,
'conversationId' | 'quote'
>;
// eslint-disable-next-line local-rules/type-alias-readonlydeep
export type ComposerStateType = {
conversations: Record<string, ComposerStateByConversationType>;
};
function getEmptyComposerState(): ComposerStateByConversationType {
return {
attachments: [],
focusCounter: 0,
isDisabled: false,
linkPreviewLoading: false,
messageCompositionId: UUID.generate().toString(),
sendCounter: 0,
};
}
export function getComposerStateForConversation(
composer: ComposerStateType,
conversationId: string
): ComposerStateByConversationType {
return composer.conversations[conversationId] ?? getEmptyComposerState();
}
2021-06-25 16:08:16 +00:00
// Actions
2021-09-24 20:02:30 +00:00
const ADD_PENDING_ATTACHMENT = 'composer/ADD_PENDING_ATTACHMENT';
const INCREMENT_SEND_COUNTER = 'composer/INCREMENT_SEND_COUNTER';
2021-06-25 16:08:16 +00:00
const REPLACE_ATTACHMENTS = 'composer/REPLACE_ATTACHMENTS';
const RESET_COMPOSER = 'composer/RESET_COMPOSER';
export const SET_FOCUS = 'composer/SET_FOCUS';
2021-06-25 16:08:16 +00:00
const SET_HIGH_QUALITY_SETTING = 'composer/SET_HIGH_QUALITY_SETTING';
const SET_QUOTED_MESSAGE = 'composer/SET_QUOTED_MESSAGE';
2022-12-08 07:43:48 +00:00
const SET_COMPOSER_DISABLED = 'composer/SET_COMPOSER_DISABLED';
2021-06-25 16:08:16 +00:00
type AddPendingAttachmentActionType = ReadonlyDeep<{
2021-09-24 20:02:30 +00:00
type: typeof ADD_PENDING_ATTACHMENT;
payload: {
conversationId: string;
attachment: AttachmentDraftType;
};
}>;
2021-09-24 20:02:30 +00:00
export type IncrementSendActionType = ReadonlyDeep<{
type: typeof INCREMENT_SEND_COUNTER;
payload: {
conversationId: string;
};
}>;
// eslint-disable-next-line local-rules/type-alias-readonlydeep
2023-01-02 21:34:41 +00:00
export type ReplaceAttachmentsActionType = {
2021-06-25 16:08:16 +00:00
type: typeof REPLACE_ATTACHMENTS;
payload: {
conversationId: string;
attachments: ReadonlyArray<AttachmentDraftType>;
};
2021-06-25 16:08:16 +00:00
};
export type ResetComposerActionType = ReadonlyDeep<{
2021-06-25 16:08:16 +00:00
type: typeof RESET_COMPOSER;
payload: {
conversationId: string;
};
}>;
2021-06-25 16:08:16 +00:00
type SetComposerDisabledStateActionType = ReadonlyDeep<{
2022-12-08 07:43:48 +00:00
type: typeof SET_COMPOSER_DISABLED;
payload: {
conversationId: string;
value: boolean;
};
}>;
2022-12-08 07:43:48 +00:00
export type SetFocusActionType = ReadonlyDeep<{
type: typeof SET_FOCUS;
payload: {
conversationId: string;
};
}>;
type SetHighQualitySettingActionType = ReadonlyDeep<{
2021-06-25 16:08:16 +00:00
type: typeof SET_HIGH_QUALITY_SETTING;
payload: {
conversationId: string;
value: boolean;
};
}>;
2021-06-25 16:08:16 +00:00
// eslint-disable-next-line local-rules/type-alias-readonlydeep
2023-01-02 21:34:41 +00:00
export type SetQuotedMessageActionType = {
2021-06-25 16:08:16 +00:00
type: typeof SET_QUOTED_MESSAGE;
payload: {
conversationId: string;
quotedMessage?: QuotedMessageType;
};
2021-06-25 16:08:16 +00:00
};
// eslint-disable-next-line local-rules/type-alias-readonlydeep
2021-06-25 16:08:16 +00:00
type ComposerActionType =
2022-06-17 00:48:57 +00:00
| AddLinkPreviewActionType
2021-09-24 20:02:30 +00:00
| AddPendingAttachmentActionType
| ConversationUnloadedActionType
| IncrementSendActionType
2021-09-24 20:02:30 +00:00
| RemoveLinkPreviewActionType
2021-06-25 16:08:16 +00:00
| ReplaceAttachmentsActionType
| ResetComposerActionType
2023-03-20 22:23:53 +00:00
| TargetedConversationChangedActionType
2022-12-08 07:43:48 +00:00
| SetComposerDisabledStateActionType
| SetFocusActionType
2021-06-25 16:08:16 +00:00
| SetHighQualitySettingActionType
| SetQuotedMessageActionType;
// Action Creators
export const actions = {
2021-09-24 20:02:30 +00:00
addAttachment,
addPendingAttachment,
cancelJoinRequest,
incrementSendCounter,
onClearAttachments,
onCloseLinkPreview,
onEditorStateChange,
onTextTooLong,
2021-09-24 20:02:30 +00:00
processAttachments,
reactToMessage,
2021-09-24 20:02:30 +00:00
removeAttachment,
2021-06-25 16:08:16 +00:00
replaceAttachments,
resetComposer,
scrollToQuotedMessage,
sendEditedMessage,
2022-12-08 07:43:48 +00:00
sendMultiMediaMessage,
sendStickerMessage,
setComposerDisabledState,
setComposerFocus,
2021-06-25 16:08:16 +00:00
setMediaQualitySetting,
setQuoteByMessageId,
2021-06-25 16:08:16 +00:00
setQuotedMessage,
};
function incrementSendCounter(conversationId: string): IncrementSendActionType {
return {
type: INCREMENT_SEND_COUNTER,
payload: {
conversationId,
},
};
}
export const useComposerActions = (): BoundActionCreatorsMapObject<
typeof actions
> => useBoundActions(actions);
function onClearAttachments(conversationId: string): NoopActionType {
const conversation = window.ConversationController.get(conversationId);
if (!conversation) {
throw new Error('onClearAttachments: No conversation found');
}
void clearConversationDraftAttachments(
conversation.id,
conversation.get('draftAttachments')
);
return {
type: 'NOOP',
payload: null,
};
}
function cancelJoinRequest(conversationId: string): NoopActionType {
const conversation = window.ConversationController.get(conversationId);
if (!conversation) {
throw new Error('cancelJoinRequest: No conversation found');
}
void longRunningTaskWrapper({
idForLogging: conversation.idForLogging(),
name: 'cancelJoinRequest',
task: async () => conversation.cancelJoinRequest(),
});
return {
type: 'NOOP',
payload: null,
};
}
function onCloseLinkPreview(conversationId: string): NoopActionType {
suspendLinkPreviews();
removeLinkPreview(conversationId);
return {
type: 'NOOP',
payload: null,
};
}
function onTextTooLong(): ShowToastActionType {
return {
type: SHOW_TOAST,
payload: {
toastType: ToastType.MessageBodyTooLong,
},
};
}
function scrollToQuotedMessage({
authorId,
conversationId,
sentAt,
}: Readonly<{
authorId: string;
conversationId: string;
sentAt: number;
}>): ThunkAction<
void,
RootStateType,
unknown,
ShowToastActionType | ScrollToMessageActionType
> {
return async (dispatch, getState) => {
const messages = await window.Signal.Data.getMessagesBySentAt(sentAt);
const message = messages.find(item =>
Boolean(
item.conversationId === conversationId &&
authorId &&
getContactId(item) === authorId
)
);
if (!message) {
dispatch({
type: SHOW_TOAST,
payload: {
toastType: ToastType.OriginalMessageNotFound,
},
});
return;
}
if (getState().conversations.selectedConversationId !== conversationId) {
return;
}
scrollToMessage(conversationId, message.id)(dispatch, getState, undefined);
};
}
2023-03-02 20:55:40 +00:00
export function handleLeaveConversation(
conversationId: string
): ThunkAction<void, RootStateType, unknown, never> {
return (dispatch, getState) => {
const { audioRecorder } = getState();
if (audioRecorder.recordingState !== RecordingState.Recording) {
return;
}
// save draft of voice note
dispatch(
completeRecording(conversationId, attachment => {
dispatch(
addPendingAttachment(conversationId, { ...attachment, pending: true })
);
dispatch(addAttachment(conversationId, attachment));
})
);
};
}
// eslint-disable-next-line local-rules/type-alias-readonlydeep
type WithPreSendChecksOptions = Readonly<{
bodyRanges?: DraftBodyRanges;
message?: string;
isEditedMessage?: boolean;
voiceNoteAttachment?: InMemoryAttachmentDraftType;
}>;
async function withPreSendChecks(
2022-12-08 07:43:48 +00:00
conversationId: string,
options: WithPreSendChecksOptions,
dispatch: ThunkDispatch<
RootStateType,
unknown,
SetComposerDisabledStateActionType | ShowToastActionType
>,
body: () => Promise<void>
): Promise<void> {
const conversation = window.ConversationController.get(conversationId);
if (!conversation) {
throw new Error('sendMultiMediaMessage: No conversation found');
2022-12-08 07:43:48 +00:00
}
const sendStart = Date.now();
const recipientsByConversation = getRecipientsByConversation([
conversation.attributes,
]);
2022-12-08 07:43:48 +00:00
const { bodyRanges, isEditedMessage, message, voiceNoteAttachment } = options;
2022-12-08 07:43:48 +00:00
try {
dispatch(setComposerDisabledState(conversationId, true));
2022-12-08 07:43:48 +00:00
try {
const sendAnyway = await blockSendUntilConversationsAreVerified(
recipientsByConversation,
SafetyNumberChangeSource.MessageSend
);
if (!sendAnyway) {
dispatch(setComposerDisabledState(conversationId, false));
2022-12-08 07:43:48 +00:00
return;
}
} catch (error) {
log.error(
'withPreSendChecks block until verified error:',
Errors.toLogFormat(error)
);
return;
}
try {
2023-06-14 22:00:30 +00:00
const hasFormatting = bodyRanges?.some(BodyRange.isFormatting);
if (hasFormatting && !window.storage.get('formattingWarningShown')) {
const sendAnyway = await maybeBlockSendForFormattingModal();
if (!sendAnyway) {
dispatch(setComposerDisabledState(conversationId, false));
return;
}
drop(window.storage.put('formattingWarningShown', true));
}
} catch (error) {
log.error(
'withPreSendChecks block for formatting modal:',
Errors.toLogFormat(error)
);
2022-12-08 07:43:48 +00:00
return;
}
try {
if (
isEditedMessage &&
!window.storage.get('sendEditWarningShown') &&
!window.SignalCI
) {
const sendAnyway = await maybeBlockSendForEditWarningModal();
if (!sendAnyway) {
dispatch(setComposerDisabledState(conversationId, false));
return;
}
drop(window.storage.put('sendEditWarningShown', true));
}
} catch (error) {
log.error(
'withPreSendChecks block for send edit warning modal:',
Errors.toLogFormat(error)
);
return;
}
const toast = shouldShowInvalidMessageToast(conversation.attributes);
if (toast != null) {
2022-12-08 07:43:48 +00:00
dispatch({
type: SHOW_TOAST,
payload: toast,
2022-12-08 07:43:48 +00:00
});
return;
}
2022-12-19 22:33:55 +00:00
if (
!message?.length &&
2022-12-19 22:33:55 +00:00
!hasDraftAttachments(conversation.attributes.draftAttachments, {
includePending: false,
}) &&
!voiceNoteAttachment
) {
return;
}
2022-12-08 07:43:48 +00:00
const sendDelta = Date.now() - sendStart;
log.info(`withPreSendChecks: Send pre-checks took ${sendDelta}ms`);
await body();
} finally {
dispatch(setComposerDisabledState(conversationId, false));
}
conversation.clearTypingTimers();
}
function sendEditedMessage(
conversationId: string,
options: WithPreSendChecksOptions & {
targetMessageId: string;
quoteAuthorUuid?: string;
quoteSentAt?: number;
}
): ThunkAction<
void,
RootStateType,
unknown,
SetComposerDisabledStateActionType | ShowToastActionType
> {
return async dispatch => {
const conversation = window.ConversationController.get(conversationId);
if (!conversation) {
throw new Error('sendEditedMessage: No conversation found');
}
const {
message = '',
bodyRanges,
quoteSentAt,
quoteAuthorUuid,
targetMessageId,
} = options;
await withPreSendChecks(
conversationId,
{ ...options, isEditedMessage: true },
dispatch,
async () => {
try {
await doSendEditedMessage(conversationId, {
body: message,
bodyRanges,
preview: getLinkPreviewForSend(message),
quoteAuthorUuid,
quoteSentAt,
targetMessageId,
});
} catch (error) {
log.error('sendEditedMessage', Errors.toLogFormat(error));
if (error.toastType) {
dispatch({
type: SHOW_TOAST,
payload: {
toastType: error.toastType,
},
});
}
}
}
);
};
}
function sendMultiMediaMessage(
conversationId: string,
options: WithPreSendChecksOptions & {
draftAttachments?: ReadonlyArray<AttachmentDraftType>;
timestamp?: number;
}
): ThunkAction<
void,
RootStateType,
unknown,
| IncrementSendActionType
| NoopActionType
| ResetComposerActionType
| SetComposerDisabledStateActionType
| SetQuotedMessageActionType
| ShowToastActionType
> {
return async (dispatch, getState) => {
const conversation = window.ConversationController.get(conversationId);
if (!conversation) {
throw new Error('sendMultiMediaMessage: No conversation found');
}
const {
draftAttachments,
bodyRanges,
message = '',
timestamp = Date.now(),
voiceNoteAttachment,
} = options;
const state = getState();
await withPreSendChecks(conversationId, options, dispatch, async () => {
2022-12-08 07:43:48 +00:00
let attachments: Array<AttachmentType> = [];
if (voiceNoteAttachment) {
attachments = [voiceNoteAttachment];
} else if (draftAttachments) {
attachments = (
await Promise.all(draftAttachments.map(resolveAttachmentDraftData))
).filter(isNotNil);
}
const conversationComposerState = getComposerStateForConversation(
state.composer,
conversationId
);
const quote = conversationComposerState.quotedMessage?.quote;
2022-12-08 07:43:48 +00:00
const shouldSendHighQualityAttachments = window.reduxStore
? conversationComposerState.shouldSendHighQualityAttachments
2022-12-08 07:43:48 +00:00
: undefined;
const sendHQImages =
shouldSendHighQualityAttachments !== undefined
? shouldSendHighQualityAttachments
: state.items['sent-media-quality'] === 'high';
try {
await conversation.enqueueMessageForSend(
{
body: message,
attachments,
quote,
preview: getLinkPreviewForSend(message),
bodyRanges,
2022-12-08 07:43:48 +00:00
},
{
sendHQImages,
timestamp,
// We rely on enqueueMessageForSend to call these within redux's batch
extraReduxActions: () => {
conversation.setMarkedUnread(false);
resetLinkPreview(conversationId);
drop(
clearConversationDraftAttachments(
conversationId,
draftAttachments
)
);
setQuoteByMessageId(conversationId, undefined)(
dispatch,
getState,
undefined
);
dispatch(incrementSendCounter(conversationId));
dispatch(setComposerDisabledState(conversationId, false));
2023-05-09 15:51:11 +00:00
if (state.items.audioMessage) {
drop(new Sound({ soundType: SoundType.Whoosh }).play());
}
},
}
);
} catch (error) {
log.error(
'Error pulling attached files before send',
Errors.toLogFormat(error)
);
}
});
2022-12-08 07:43:48 +00:00
};
}
function sendStickerMessage(
conversationId: string,
options: {
packId: string;
stickerId: number;
}
): ThunkAction<
void,
RootStateType,
unknown,
NoopActionType | ShowToastActionType
> {
return async dispatch => {
const conversation = window.ConversationController.get(conversationId);
if (!conversation) {
throw new Error('sendStickerMessage: No conversation found');
}
const recipientsByConversation = getRecipientsByConversation([
conversation.attributes,
]);
try {
const sendAnyway = await blockSendUntilConversationsAreVerified(
recipientsByConversation,
SafetyNumberChangeSource.MessageSend
);
if (!sendAnyway) {
return;
}
const toast = shouldShowInvalidMessageToast(conversation.attributes);
if (toast != null) {
2022-12-08 07:43:48 +00:00
dispatch({
type: SHOW_TOAST,
payload: toast,
2022-12-08 07:43:48 +00:00
});
return;
}
const { packId, stickerId } = options;
void conversation.sendStickerMessage(packId, stickerId);
2022-12-08 07:43:48 +00:00
} catch (error) {
log.error('clickSend error:', Errors.toLogFormat(error));
}
dispatch({
type: 'NOOP',
payload: null,
});
};
}
2021-09-24 20:02:30 +00:00
// Not cool that we have to pull from ConversationModel here
// but if the current selected conversation isn't the one that we're operating
// on then we won't be able to grab attachments from state so we resort to the
// next in-memory store.
function getAttachmentsFromConversationModel(
conversationId: string
): ReadonlyArray<AttachmentDraftType> {
2021-09-24 20:02:30 +00:00
const conversation = window.ConversationController.get(conversationId);
return conversation?.get('draftAttachments') || [];
}
2023-01-02 21:34:41 +00:00
export function setQuoteByMessageId(
conversationId: string,
messageId: string | undefined
): ThunkAction<
void,
RootStateType,
unknown,
SetComposerDisabledStateActionType | SetQuotedMessageActionType
> {
return async (dispatch, getState) => {
const conversation = window.ConversationController.get(conversationId);
if (!conversation) {
throw new Error('sendStickerMessage: No conversation found');
}
2023-05-09 21:13:19 +00:00
const draftEditMessage = conversation.get('draftEditMessage');
if (draftEditMessage) {
return;
}
const message = messageId ? await getMessageById(messageId) : undefined;
const state = getState();
if (
message &&
!canReply(
message.attributes,
window.ConversationController.getOurConversationIdOrThrow(),
getConversationSelector(state)
)
) {
return;
}
if (message && !message.isNormalBubble()) {
return;
}
const existing = conversation.get('quotedMessageId');
if (existing !== messageId) {
const now = Date.now();
let activeAt = conversation.get('active_at');
let timestamp = conversation.get('timestamp');
if (!activeAt && messageId) {
activeAt = now;
timestamp = now;
}
conversation.set({
active_at: activeAt,
draftChanged: true,
quotedMessageId: messageId,
timestamp,
});
window.Signal.Data.updateConversation(conversation.attributes);
}
if (message) {
2023-03-27 23:48:57 +00:00
const quote = await makeQuote(message.attributes);
// In case the conversation changed while we were about to set the quote
if (getState().conversations.selectedConversationId !== conversationId) {
return;
}
2023-05-09 21:13:19 +00:00
dispatch(
setQuotedMessage(conversationId, {
conversationId,
quote,
})
);
dispatch(setComposerFocus(conversation.id));
dispatch(setComposerDisabledState(conversationId, false));
} else {
dispatch(setQuotedMessage(conversationId, undefined));
}
};
}
2021-09-24 20:02:30 +00:00
function addAttachment(
conversationId: string,
attachment: InMemoryAttachmentDraftType
2021-09-24 20:02:30 +00:00
): ThunkAction<void, RootStateType, unknown, ReplaceAttachmentsActionType> {
return async (dispatch, getState) => {
// We do async operations first so multiple in-process addAttachments don't stomp on
// each other.
const onDisk = await writeDraftAttachment(attachment);
const state = getState();
2021-09-24 20:02:30 +00:00
const isSelectedConversation =
state.conversations.selectedConversationId === conversationId;
const conversationComposerState = getComposerStateForConversation(
state.composer,
conversationId
);
2021-09-24 20:02:30 +00:00
const draftAttachments = isSelectedConversation
? conversationComposerState.attachments
2021-09-24 20:02:30 +00:00
: getAttachmentsFromConversationModel(conversationId);
2021-12-01 02:14:25 +00:00
// We expect there to either be a pending draft attachment or an existing
// attachment that we'll be replacing.
2021-09-24 20:02:30 +00:00
const hasDraftAttachmentPending = draftAttachments.some(
2021-12-01 02:14:25 +00:00
draftAttachment => draftAttachment.path === attachment.path
2021-09-24 20:02:30 +00:00
);
// User has canceled the draft so we don't need to continue processing
if (!hasDraftAttachmentPending) {
await deleteDraftAttachment(onDisk);
2021-09-24 20:02:30 +00:00
return;
}
// Remove any pending attachments that were transcoding
const index = draftAttachments.findIndex(
draftAttachment => draftAttachment.path === attachment.path
);
let nextAttachments = draftAttachments;
if (index < 0) {
log.warn(
`addAttachment: Failed to find pending attachment with path ${attachment.path}`
);
nextAttachments = [...draftAttachments, onDisk];
} else {
nextAttachments = replaceIndex(draftAttachments, index, onDisk);
}
replaceAttachments(conversationId, nextAttachments)(
dispatch,
getState,
null
);
const conversation = window.ConversationController.get(conversationId);
if (conversation) {
2023-03-02 20:55:40 +00:00
conversation.set({
draftAttachments: nextAttachments,
draftChanged: true,
});
// if the conversation has already unloaded
if (!isSelectedConversation) {
const now = Date.now();
const activeAt = conversation.get('active_at') || now;
conversation.set({
active_at: activeAt,
draftChanged: false,
draftTimestamp: now,
timestamp: now,
});
}
2021-09-24 20:02:30 +00:00
window.Signal.Data.updateConversation(conversation.attributes);
}
};
}
function addPendingAttachment(
conversationId: string,
pendingAttachment: AttachmentDraftType
2021-09-24 20:02:30 +00:00
): ThunkAction<void, RootStateType, unknown, ReplaceAttachmentsActionType> {
return (dispatch, getState) => {
const state = getState();
2021-09-24 20:02:30 +00:00
const isSelectedConversation =
state.conversations.selectedConversationId === conversationId;
const conversationComposerState = getComposerStateForConversation(
state.composer,
conversationId
);
2021-09-24 20:02:30 +00:00
const draftAttachments = isSelectedConversation
? conversationComposerState.attachments
2021-09-24 20:02:30 +00:00
: getAttachmentsFromConversationModel(conversationId);
const nextAttachments = [...draftAttachments, pendingAttachment];
dispatch({
type: REPLACE_ATTACHMENTS,
payload: {
conversationId,
attachments: nextAttachments,
},
2021-09-24 20:02:30 +00:00
});
const conversation = window.ConversationController.get(conversationId);
if (conversation) {
conversation.attributes.draftAttachments = nextAttachments;
conversation.attributes.draftChanged = true;
2021-09-24 20:02:30 +00:00
window.Signal.Data.updateConversation(conversation.attributes);
}
};
}
2023-01-02 21:34:41 +00:00
export function setComposerFocus(
conversationId: string
): ThunkAction<void, RootStateType, unknown, SetFocusActionType> {
return async (dispatch, getState) => {
if (getState().conversations.selectedConversationId !== conversationId) {
return;
}
dispatch({
type: SET_FOCUS,
payload: {
conversationId,
},
});
};
}
function onEditorStateChange({
bodyRanges,
caretLocation,
conversationId,
messageText,
sendCounter,
}: {
bodyRanges: DraftBodyRanges;
caretLocation?: number;
conversationId: string | undefined;
messageText: string;
sendCounter: number;
}): ThunkAction<void, RootStateType, unknown, NoopActionType> {
return (dispatch, getState) => {
if (!conversationId) {
throw new Error(
'onEditorStateChange: Got falsey conversationId, needs local override'
);
}
const conversation = window.ConversationController.get(conversationId);
if (!conversation) {
throw new Error('processAttachments: Unable to find conversation');
}
const state = getState().composer.conversations[conversationId];
if (!state) {
return;
}
if (state.sendCounter !== sendCounter) {
log.warn(
`onEditorStateChange: Got update for conversation ${conversation.idForLogging()}`,
`but sendCounter doesnt match (old: ${state.sendCounter}, new: ${sendCounter})`
);
return;
}
if (messageText.length && conversation.throttledBumpTyping) {
conversation.throttledBumpTyping();
}
debouncedSaveDraft(conversationId, messageText, bodyRanges);
// If we have attachments, don't add link preview
if (
hasDraftAttachments(conversation.attributes.draftAttachments, {
includePending: true,
}) ||
Boolean(conversation.attributes.draftEditMessage?.attachmentThumbnail) ||
// If we already didn't have a preview attached, don't fetch another one
(conversation.attributes.draftEditMessage &&
!conversation.attributes.draftEditMessage.preview)
) {
return;
}
maybeGrabLinkPreview(messageText, LinkPreviewSourceType.Composer, {
caretLocation,
conversationId,
});
dispatch({
type: 'NOOP',
payload: null,
});
};
}
function processAttachments({
conversationId,
files,
}: {
conversationId: string;
files: ReadonlyArray<File>;
}): ThunkAction<
void,
RootStateType,
unknown,
NoopActionType | ShowToastActionType
> {
return async (dispatch, getState) => {
if (!files.length) {
return;
}
// If the call came from a conversation we are no longer in we do not
// update the state.
if (getState().conversations.selectedConversationId !== conversationId) {
return;
}
const conversation = window.ConversationController.get(conversationId);
if (!conversation) {
throw new Error('processAttachments: Unable to find conv');
}
const state = getState();
const isRecording =
state.audioRecorder.recordingState === RecordingState.Recording;
if (hasLinkPreviewLoaded() || isRecording) {
return;
}
let toastToShow: AnyToast | undefined;
const nextDraftAttachments = (
conversation.get('draftAttachments') || []
).slice();
const filesToProcess: Array<File> = [];
for (let i = 0; i < files.length; i += 1) {
const file = files[i];
const processingResult = preProcessAttachment(file, nextDraftAttachments);
if (processingResult != null) {
toastToShow = processingResult;
} else {
const pendingAttachment = getPendingAttachment(file);
if (pendingAttachment) {
addPendingAttachment(conversationId, pendingAttachment)(
dispatch,
getState,
undefined
);
filesToProcess.push(file);
// we keep a running count of the draft attachments so we can show a
// toast in case we add too many attachments at once
nextDraftAttachments.push(pendingAttachment);
}
}
}
await Promise.all(
filesToProcess.map(async file => {
try {
const attachment = await processAttachment(file, {
generateScreenshot: true,
});
if (!attachment) {
removeAttachment(conversationId, file.path)(
dispatch,
getState,
undefined
);
return;
}
addAttachment(conversationId, attachment)(
dispatch,
getState,
undefined
);
} catch (err) {
log.error(
'handleAttachmentsProcessing: failed to process attachment:',
err.stack
);
removeAttachment(conversationId, file.path)(
dispatch,
getState,
undefined
);
toastToShow = { toastType: ToastType.UnableToLoadAttachment };
}
})
);
if (toastToShow) {
dispatch({
type: SHOW_TOAST,
payload: toastToShow,
});
return;
}
2021-09-24 20:02:30 +00:00
dispatch({
type: 'NOOP',
payload: null,
});
};
}
function preProcessAttachment(
file: File,
draftAttachments: Array<AttachmentDraftType>
): AnyToast | undefined {
if (!file) {
return;
}
const limitKb = getMaximumAttachmentSizeInKb(getRemoteConfigValue);
if (file.size / KIBIBYTE > limitKb) {
return {
toastType: ToastType.FileSize,
parameters: getRenderDetailsForLimit(limitKb),
};
}
if (isFileDangerous(file.name)) {
return { toastType: ToastType.DangerousFileType };
}
if (draftAttachments.length >= 32) {
return { toastType: ToastType.MaxAttachments };
}
const haveNonImageOrVideo = draftAttachments.some(
(attachment: AttachmentDraftType) => {
return (
!isImage(attachment.contentType) && !isVideo(attachment.contentType)
);
}
);
// You can't add another attachment if you already have a non-image staged
if (haveNonImageOrVideo) {
return { toastType: ToastType.UnsupportedMultiAttachment };
}
const fileType = stringToMIMEType(file.type);
const imageOrVideo = isImage(fileType) || isVideo(fileType);
// You can't add a non-image attachment if you already have attachments staged
if (!imageOrVideo && draftAttachments.length > 0) {
return { toastType: ToastType.CannotMixMultiAndNonMultiAttachments };
}
return undefined;
}
function getPendingAttachment(file: File): AttachmentDraftType | undefined {
if (!file) {
return;
}
const fileType = stringToMIMEType(file.type);
const { name: fileName } = path.parse(file.name);
return {
contentType: fileType,
fileName,
size: file.size,
path: file.name,
pending: true,
};
}
2021-09-24 20:02:30 +00:00
function removeAttachment(
conversationId: string,
filePath: string
): ThunkAction<void, RootStateType, unknown, ReplaceAttachmentsActionType> {
return async (dispatch, getState) => {
const state = getState();
const { attachments } = getComposerStateForConversation(
state.composer,
conversationId
);
2021-09-24 20:02:30 +00:00
const [targetAttachment] = attachments.filter(
attachment => attachment.path === filePath
);
if (!targetAttachment) {
return;
}
2021-09-24 20:02:30 +00:00
const nextAttachments = attachments.filter(
attachment => attachment.path !== filePath
);
const conversation = window.ConversationController.get(conversationId);
if (conversation) {
conversation.attributes.draftAttachments = nextAttachments;
conversation.attributes.draftChanged = true;
window.Signal.Data.updateConversation(conversation.attributes);
}
replaceAttachments(conversationId, nextAttachments)(
dispatch,
getState,
null
);
if (
targetAttachment.path &&
targetAttachment.fileName !== targetAttachment.path
) {
await deleteDraftAttachment(targetAttachment);
}
2021-09-24 20:02:30 +00:00
};
}
2023-01-02 21:34:41 +00:00
export function replaceAttachments(
2021-08-09 20:06:21 +00:00
conversationId: string,
attachments: ReadonlyArray<AttachmentDraftType>
2021-08-09 20:06:21 +00:00
): ThunkAction<void, RootStateType, unknown, ReplaceAttachmentsActionType> {
return (dispatch, getState) => {
// If the call came from a conversation we are no longer in we do not
// update the state.
if (getState().conversations.selectedConversationId !== conversationId) {
return;
}
if (hasDraftAttachments(attachments, { includePending: true })) {
removeLinkPreview(conversationId);
}
2021-08-09 20:06:21 +00:00
dispatch({
type: REPLACE_ATTACHMENTS,
payload: {
conversationId,
attachments: attachments.map(resolveDraftAttachmentOnDisk),
},
2021-08-09 20:06:21 +00:00
});
dispatch(setComposerFocus(conversationId));
2021-06-25 16:08:16 +00:00
};
}
function reactToMessage(
messageId: string,
reaction: { emoji: string; remove: boolean }
): ThunkAction<
void,
RootStateType,
unknown,
NoopActionType | ShowToastActionType
> {
return async dispatch => {
const { emoji, remove } = reaction;
try {
await enqueueReactionForSend({
messageId,
emoji,
remove,
});
dispatch({
type: 'NOOP',
payload: null,
});
} catch (error) {
log.error(
'reactToMessage: Error sending reaction',
error,
messageId,
reaction
);
dispatch({
type: SHOW_TOAST,
payload: {
toastType: ToastType.ReactionFailed,
},
});
}
};
}
export function resetComposer(conversationId: string): ResetComposerActionType {
2021-06-25 16:08:16 +00:00
return {
type: RESET_COMPOSER,
payload: {
conversationId,
},
2021-06-25 16:08:16 +00:00
};
}
2023-07-31 16:21:51 +00:00
const debouncedSaveDraft = debounce(saveDraft, 100);
function saveDraft(
conversationId: string,
messageText: string,
bodyRanges: DraftBodyRanges
) {
const conversation = window.ConversationController.get(conversationId);
if (!conversation) {
throw new Error('saveDraft: Unable to find conversation');
}
const trimmed =
messageText && messageText.length > 0 ? messageText.trim() : '';
if (conversation.get('draft') && (!messageText || trimmed.length === 0)) {
conversation.set({
draft: null,
draftChanged: true,
draftBodyRanges: [],
});
window.Signal.Data.updateConversation(conversation.attributes);
return;
}
if (
messageText !== conversation.get('draft') ||
!isEqual(bodyRanges, conversation.get('draftBodyRanges'))
) {
const now = Date.now();
let activeAt = conversation.get('active_at');
let timestamp = conversation.get('timestamp');
if (!activeAt) {
activeAt = now;
timestamp = now;
}
conversation.set({
active_at: activeAt,
draft: messageText,
draftBodyRanges: bodyRanges,
draftChanged: true,
timestamp,
});
window.Signal.Data.updateConversation(conversation.attributes);
}
}
2021-06-25 16:08:16 +00:00
2022-12-08 07:43:48 +00:00
function setComposerDisabledState(
conversationId: string,
2022-12-08 07:43:48 +00:00
value: boolean
): SetComposerDisabledStateActionType {
return {
type: SET_COMPOSER_DISABLED,
payload: {
conversationId,
value,
},
2022-12-08 07:43:48 +00:00
};
}
2021-06-25 16:08:16 +00:00
function setMediaQualitySetting(
conversationId: string,
value: boolean
2021-06-25 16:08:16 +00:00
): SetHighQualitySettingActionType {
return {
type: SET_HIGH_QUALITY_SETTING,
payload: {
conversationId,
value,
},
2021-06-25 16:08:16 +00:00
};
}
function setQuotedMessage(
conversationId: string,
quotedMessage?: QuotedMessageType
2021-06-25 16:08:16 +00:00
): SetQuotedMessageActionType {
return {
type: SET_QUOTED_MESSAGE,
payload: {
conversationId,
quotedMessage,
},
2021-06-25 16:08:16 +00:00
};
}
// Reducer
export function getEmptyState(): ComposerStateType {
return {
conversations: {},
2021-06-25 16:08:16 +00:00
};
}
function updateComposerState(
state: Readonly<ComposerStateType>,
action: Readonly<ComposerActionType>,
getNextComposerState: (
prevState: ComposerStateByConversationType
) => Partial<ComposerStateByConversationType>
): ComposerStateType {
const { conversationId } = action.payload;
strictAssert(
conversationId,
'updateComposerState: no conversationId provided'
);
const prevComposerState = getComposerStateForConversation(
state,
conversationId
);
const nextComposerStateForConversation = assignWithNoUnnecessaryAllocation(
prevComposerState,
getNextComposerState(prevComposerState)
);
return assignWithNoUnnecessaryAllocation(state, {
conversations: assignWithNoUnnecessaryAllocation(state.conversations, {
[conversationId]: nextComposerStateForConversation,
}),
});
}
2021-06-25 16:08:16 +00:00
export function reducer(
state: Readonly<ComposerStateType> = getEmptyState(),
action: Readonly<ComposerActionType>
): ComposerStateType {
if (action.type === CONVERSATION_UNLOADED) {
const nextConversations: Record<string, ComposerStateByConversationType> =
{};
Object.keys(state.conversations).forEach(conversationId => {
if (conversationId === action.payload.conversationId) {
return;
}
nextConversations[conversationId] = state.conversations[conversationId];
});
return {
...state,
conversations: nextConversations,
};
}
2023-03-20 22:23:53 +00:00
if (action.type === TARGETED_CONVERSATION_CHANGED) {
if (action.payload.conversationId) {
return {
...state,
conversations: {
[action.payload.conversationId]: getEmptyComposerState(),
},
};
}
2021-06-25 16:08:16 +00:00
return getEmptyState();
}
if (action.type === RESET_COMPOSER) {
return updateComposerState(state, action, () => ({}));
}
2021-06-25 16:08:16 +00:00
if (action.type === REPLACE_ATTACHMENTS) {
const { attachments } = action.payload;
return updateComposerState(state, action, () => ({
2021-06-25 16:08:16 +00:00
attachments,
...(attachments.length
? {}
: { shouldSendHighQualityAttachments: undefined }),
}));
2021-06-25 16:08:16 +00:00
}
if (action.type === INCREMENT_SEND_COUNTER) {
return updateComposerState(state, action, prevState => ({
sendCounter: prevState.sendCounter + 1,
}));
}
if (action.type === SET_FOCUS) {
return updateComposerState(state, action, prevState => ({
focusCounter: prevState.focusCounter + 1,
}));
}
2021-06-25 16:08:16 +00:00
if (action.type === SET_HIGH_QUALITY_SETTING) {
return updateComposerState(state, action, () => ({
shouldSendHighQualityAttachments: action.payload.value,
}));
2021-06-25 16:08:16 +00:00
}
if (action.type === SET_QUOTED_MESSAGE) {
const { quotedMessage } = action.payload;
return updateComposerState(state, action, () => ({
quotedMessage,
}));
2021-06-25 16:08:16 +00:00
}
2022-06-17 00:48:57 +00:00
if (action.type === ADD_LINK_PREVIEW) {
if (action.payload.source !== LinkPreviewSourceType.Composer) {
return state;
}
return updateComposerState(state, action, () => ({
2022-06-17 00:48:57 +00:00
linkPreviewLoading: true,
2021-06-25 16:08:16 +00:00
linkPreviewResult: action.payload.linkPreview,
}));
2021-06-25 16:08:16 +00:00
}
if (action.type === REMOVE_LINK_PREVIEW && action.payload.conversationId) {
return updateComposerState(state, action, () => ({
2021-08-18 13:34:22 +00:00
linkPreviewLoading: false,
linkPreviewResult: undefined,
}));
2021-08-18 13:34:22 +00:00
}
2021-09-24 20:02:30 +00:00
if (action.type === ADD_PENDING_ATTACHMENT) {
return updateComposerState(state, action, prevState => ({
attachments: [...prevState.attachments, action.payload.attachment],
}));
2021-09-24 20:02:30 +00:00
}
2022-12-08 07:43:48 +00:00
if (action.type === SET_COMPOSER_DISABLED) {
return updateComposerState(state, action, () => ({
isDisabled: action.payload.value,
}));
2022-12-08 07:43:48 +00:00
}
2021-06-25 16:08:16 +00:00
return state;
}