// Copyright 2018 Signal Messenger, LLC // SPDX-License-Identifier: AGPL-3.0-only // The idea with this file is to make it webpackable for the style guide import type { ReadonlyDeep } from 'type-fest'; import * as Crypto from './Crypto'; import * as Curve from './Curve'; import { start as conversationControllerStart } from './ConversationController'; import * as Groups from './groups'; import OS from './util/os/osMain'; import { isProduction } from './util/version'; import * as RemoteConfig from './RemoteConfig'; import { DataReader, DataWriter } from './sql/Client'; // Components import { ConfirmationDialog } from './components/ConfirmationDialog'; // State import { createApp } from './state/roots/createApp'; import { createSafetyNumberViewer } from './state/roots/createSafetyNumberViewer'; // Types import * as TypesAttachment from './types/Attachment'; import * as VisualAttachment from './types/VisualAttachment'; import * as MessageType from './types/Message2'; import { Address } from './types/Address'; import { QualifiedAddress } from './types/QualifiedAddress'; // Processes / Services import { initializeGroupCredentialFetcher } from './services/groupCredentialFetcher'; import { initializeNetworkObserver } from './services/networkObserver'; import { initializeUpdateListener } from './services/updateListener'; import { calling } from './services/calling'; import * as storage from './services/storage'; import { backupsService } from './services/backups'; import type { LoggerType } from './types/Logging'; import type { AttachmentType, AttachmentWithHydratedData, AddressableAttachmentType, LocalAttachmentV2Type, } from './types/Attachment'; import type { MessageAttributesType, QuotedMessageType } from './model-types.d'; import type { SignalCoreType } from './window.d'; import type { EmbeddedContactType, EmbeddedContactWithHydratedAvatar, } from './types/EmbeddedContact'; import type { LinkPreviewType, LinkPreviewWithHydratedData, } from './types/message/LinkPreviews'; import type { StickerType, StickerWithHydratedData } from './types/Stickers'; type EncryptedReader = ( attachment: Partial ) => Promise; type EncryptedWriter = (data: Uint8Array) => Promise; type MigrationsModuleType = { attachmentsPath: string; copyIntoAttachmentsDirectory: ( path: string ) => Promise<{ path: string; size: number }>; copyIntoTempDirectory: ( path: string ) => Promise<{ path: string; size: number }>; deleteAttachmentData: (path: string) => Promise; deleteAvatar: (path: string) => Promise; deleteDownloadData: (path: string) => Promise; deleteDraftFile: (path: string) => Promise; deleteExternalMessageFiles: ( attributes: MessageAttributesType ) => Promise; deleteSticker: (path: string) => Promise; deleteTempFile: (path: string) => Promise; doesAttachmentExist: (path: string) => Promise; ensureAttachmentIsReencryptable: ( attachment: TypesAttachment.LocallySavedAttachment ) => Promise; getAbsoluteAttachmentPath: (path: string) => string; getAbsoluteAvatarPath: (src: string) => string; getAbsoluteBadgeImageFilePath: (path: string) => string; getAbsoluteDownloadsPath: (path: string) => string; getAbsoluteDraftPath: (path: string) => string; getAbsoluteStickerPath: (path: string) => string; getAbsoluteTempPath: (path: string) => string; loadAttachmentData: ( attachment: Partial ) => Promise; loadContactData: ( contact: ReadonlyArray> | undefined ) => Promise | undefined>; loadMessage: ( message: MessageAttributesType ) => Promise; loadPreviewData: ( preview: ReadonlyArray> | undefined ) => Promise>; loadQuoteData: ( quote: QuotedMessageType | null | undefined ) => Promise; loadStickerData: ( sticker: StickerType | undefined ) => Promise; readAttachmentData: EncryptedReader; readAvatarData: EncryptedReader; readDraftData: EncryptedReader; readStickerData: EncryptedReader; readTempData: EncryptedReader; saveAttachmentToDisk: (options: { data: Uint8Array; name: string; }) => Promise; processNewAttachment: (attachment: AttachmentType) => Promise; processNewSticker: (stickerData: Uint8Array) => Promise< LocalAttachmentV2Type & { width: number; height: number; } >; processNewEphemeralSticker: (stickerData: Uint8Array) => Promise< LocalAttachmentV2Type & { width: number; height: number; } >; upgradeMessageSchema: ( attributes: MessageAttributesType, options?: { maxVersion?: number } ) => Promise; writeNewAttachmentData: EncryptedWriter; writeNewDraftData: EncryptedWriter; writeNewAvatarData: EncryptedWriter; writeNewStickerData: EncryptedWriter; writeNewBadgeImageFileData: (data: Uint8Array) => Promise; writeNewPlaintextTempData: (data: Uint8Array) => Promise; }; export function initializeMigrations({ getRegionCode, Attachments, Type, VisualType, logger, userDataPath, }: { getRegionCode: () => string | undefined; Attachments: AttachmentsModuleType; Type: typeof TypesAttachment; VisualType: typeof VisualAttachment; logger: LoggerType; userDataPath: string; }): MigrationsModuleType { if (!Attachments) { throw new Error('initializeMigrations: Missing provided attachments!'); } const { createAbsolutePathGetter, createPlaintextReader, createWriterForNew, createDoesExist, ensureAttachmentIsReencryptable, getAvatarsPath, getDraftPath, getDownloadsPath, getPath, getStickersPath, getBadgesPath, getTempPath, readAndDecryptDataFromDisk, saveAttachmentToDisk, } = Attachments; const { getImageDimensions, makeImageThumbnail, makeObjectUrl, makeVideoScreenshot, revokeObjectUrl, } = VisualType; const attachmentsPath = getPath(userDataPath); function createEncryptedReader(basePath: string): EncryptedReader { const fallbackReader = createPlaintextReader(basePath); const pathGetter = createAbsolutePathGetter(basePath); return async ( attachment: Partial ): Promise => { // In-memory if (attachment.data != null) { return attachment.data; } if (attachment.path == null) { throw new Error('Attachment was not downloaded yet'); } if (attachment.version !== 2) { return fallbackReader(attachment.path); } if (attachment.localKey == null || attachment.size == null) { throw new Error('Failed to decrypt v2 attachment'); } const absolutePath = pathGetter(attachment.path); return readAndDecryptDataFromDisk({ absolutePath, keysBase64: attachment.localKey, size: attachment.size, }); }; } function createEncryptedWriterForNew(basePath: string): EncryptedWriter { const pathGetter = createAbsolutePathGetter(basePath); return data => Attachments.writeNewAttachmentData({ data, getAbsoluteAttachmentPath: pathGetter, }); } const readAttachmentData = createEncryptedReader(attachmentsPath); const loadAttachmentData = Type.loadData(readAttachmentData); const loadContactData = MessageType.loadContactData(loadAttachmentData); const loadPreviewData = MessageType.loadPreviewData(loadAttachmentData); const loadQuoteData = MessageType.loadQuoteData(loadAttachmentData); const loadStickerData = MessageType.loadStickerData(loadAttachmentData); const getAbsoluteAttachmentPath = createAbsolutePathGetter(attachmentsPath); const deleteOnDisk = Attachments.createDeleter(attachmentsPath); const writeNewAttachmentData = createEncryptedWriterForNew(attachmentsPath); const copyIntoAttachmentsDirectory = Attachments.copyIntoAttachmentsDirectory(attachmentsPath); const doesAttachmentExist = createDoesExist(attachmentsPath); const stickersPath = getStickersPath(userDataPath); const getAbsoluteStickerPath = createAbsolutePathGetter(stickersPath); const writeNewStickerData = createEncryptedWriterForNew(stickersPath); const deleteSticker = Attachments.createDeleter(stickersPath); const readStickerData = createEncryptedReader(stickersPath); const badgesPath = getBadgesPath(userDataPath); const getAbsoluteBadgeImageFilePath = createAbsolutePathGetter(badgesPath); const writeNewBadgeImageFileData = createWriterForNew(badgesPath, '.svg'); const tempPath = getTempPath(userDataPath); const getAbsoluteTempPath = createAbsolutePathGetter(tempPath); const writeNewTempData = createEncryptedWriterForNew(tempPath); const writeNewPlaintextTempData = createWriterForNew(tempPath); const deleteTempFile = Attachments.createDeleter(tempPath); const readTempData = createEncryptedReader(tempPath); const copyIntoTempDirectory = Attachments.copyIntoAttachmentsDirectory(tempPath); const draftPath = getDraftPath(userDataPath); const getAbsoluteDraftPath = createAbsolutePathGetter(draftPath); const writeNewDraftData = createEncryptedWriterForNew(draftPath); const deleteDraftFile = Attachments.createDeleter(draftPath); const readDraftData = createEncryptedReader(draftPath); const downloadsPath = getDownloadsPath(userDataPath); const getAbsoluteDownloadsPath = createAbsolutePathGetter(downloadsPath); const deleteDownloadOnDisk = Attachments.createDeleter(downloadsPath); const avatarsPath = getAvatarsPath(userDataPath); const readAvatarData = createEncryptedReader(avatarsPath); const getAbsoluteAvatarPath = createAbsolutePathGetter(avatarsPath); const writeNewAvatarData = createEncryptedWriterForNew(avatarsPath); const deleteAvatar = Attachments.createDeleter(avatarsPath); return { attachmentsPath, copyIntoAttachmentsDirectory, copyIntoTempDirectory, deleteAttachmentData: deleteOnDisk, deleteAvatar, deleteDownloadData: deleteDownloadOnDisk, deleteDraftFile, deleteExternalMessageFiles: MessageType.deleteAllExternalFiles({ deleteAttachmentData: Type.deleteData({ deleteOnDisk, deleteDownloadOnDisk, }), deleteOnDisk, }), deleteSticker, deleteTempFile, doesAttachmentExist, ensureAttachmentIsReencryptable, getAbsoluteAttachmentPath, getAbsoluteAvatarPath, getAbsoluteBadgeImageFilePath, getAbsoluteDownloadsPath, getAbsoluteDraftPath, getAbsoluteStickerPath, getAbsoluteTempPath, loadAttachmentData, loadContactData, loadMessage: MessageType.createAttachmentLoader(loadAttachmentData), loadPreviewData, loadQuoteData, loadStickerData, readAttachmentData, readAvatarData, readDraftData, readStickerData, readTempData, saveAttachmentToDisk, processNewAttachment: (attachment: AttachmentType) => MessageType.processNewAttachment(attachment, { writeNewAttachmentData, ensureAttachmentIsReencryptable, makeObjectUrl, revokeObjectUrl, getImageDimensions, makeImageThumbnail, makeVideoScreenshot, deleteOnDisk, logger, }), processNewSticker: (stickerData: Uint8Array) => MessageType.processNewSticker(stickerData, false, { writeNewStickerData, getImageDimensions, logger, }), processNewEphemeralSticker: (stickerData: Uint8Array) => MessageType.processNewSticker(stickerData, true, { writeNewStickerData: writeNewTempData, getImageDimensions, logger, }), upgradeMessageSchema: ( message: MessageAttributesType, options: { maxVersion?: number } = {} ) => { const { maxVersion } = options; return MessageType.upgradeSchema(message, { deleteOnDisk, doesAttachmentExist, ensureAttachmentIsReencryptable, getImageDimensions, getRegionCode, makeImageThumbnail, makeObjectUrl, makeVideoScreenshot, readAttachmentData, revokeObjectUrl, writeNewAttachmentData, writeNewStickerData, logger, maxVersion, }); }, writeNewAttachmentData, writeNewAvatarData, writeNewDraftData, writeNewBadgeImageFileData, writeNewPlaintextTempData, writeNewStickerData, }; } type StringGetterType = (basePath: string) => string; type AttachmentsModuleType = { getAvatarsPath: StringGetterType; getBadgesPath: StringGetterType; getDownloadsPath: StringGetterType; getDraftPath: StringGetterType; getPath: StringGetterType; getStickersPath: StringGetterType; getTempPath: StringGetterType; getUpdateCachePath: StringGetterType; createDeleter: (root: string) => (relativePath: string) => Promise; createPlaintextReader: ( root: string ) => (relativePath: string) => Promise; copyIntoAttachmentsDirectory: ( root: string ) => (sourcePath: string) => Promise<{ path: string; size: number }>; createWriterForNew: ( root: string, suffix?: string ) => (bytes: Uint8Array) => Promise; createAbsolutePathGetter: ( rootPath: string ) => (relativePath: string) => string; createDoesExist: (root: string) => (relativePath: string) => Promise; saveAttachmentToDisk: ({ data, name, }: { data: Uint8Array; name: string; }) => Promise; ensureAttachmentIsReencryptable: ( attachment: TypesAttachment.LocallySavedAttachment ) => Promise; readAndDecryptDataFromDisk: (options: { absolutePath: string; keysBase64: string; size: number; }) => Promise; writeNewAttachmentData: (options: { data: Uint8Array; getAbsoluteAttachmentPath: (relativePath: string) => string; }) => Promise; }; export const setup = (options: { Attachments: AttachmentsModuleType; getRegionCode: () => string | undefined; logger: LoggerType; userDataPath: string; }): SignalCoreType => { const { Attachments, getRegionCode, logger, userDataPath } = options; const Migrations = initializeMigrations({ getRegionCode, Attachments, Type: TypesAttachment, VisualType: VisualAttachment, logger, userDataPath, }); const Components = { ConfirmationDialog, }; const Roots = { createApp, createSafetyNumberViewer, }; const Services = { backups: backupsService, calling, initializeGroupCredentialFetcher, initializeNetworkObserver, initializeUpdateListener, // Testing storage, }; const State = { Roots, }; const Types = { Message: MessageType, // Mostly for debugging Address, QualifiedAddress, }; return { Components, Crypto, Curve, // Note: used in test/index.html, and not type-checked! conversationControllerStart, Groups, Migrations, OS, RemoteConfig, Services, State, Types, ...(isProduction(window.getVersion()) ? {} : { DataReader, DataWriter, }), }; };