WIP: Autosave drafts

Closes #4419

Author: paw-hub

packages/tutanota-utils/lib/DateUtils.ts

@@ -3,7 +3,16 @@
  * As functions here do not use Luxon it cannot be used for calculating things in different time zones, they
  * are dependent on the system time zone.
  */
-export const DAY_IN_MILLIS = 1000 * 60 * 60 * 24
+
+/**
+ * Convert the number of seconds to milliseconds.
+ * @param seconds seconds to convert
+ */
+export function secondsToMillis(seconds: number): number {
+	return seconds * 1000
+}
+
+export const DAY_IN_MILLIS = secondsToMillis(60 * 60 * 24)
 
 export const YEAR_IN_MILLIS = DAY_IN_MILLIS * 365
 

packages/tutanota-utils/lib/index.ts

@@ -82,6 +82,7 @@ export {
 	isValidDate,
 	millisToDays,
 	daysToMillis,
+	secondsToMillis,
 	TIMESTAMP_ZERO_YEAR,
 } from "./DateUtils.js"
 export {

src/calendar-app/calendarLocator.ts

@@ -336,6 +336,7 @@ class CalendarLocator implements CommonLocator {
 				recipientsModel,
 				dateProvider,
 				mailboxProperties,
+				this.configFacade,
 				async (mail: Mail) => {
 					return false
 				},

src/common/api/worker/facades/lazy/ConfigurationDatabase.ts

@@ -6,6 +6,7 @@ import {
 	Aes128Key,
 	Aes256Key,
 	aes256RandomKey,
+	aesDecrypt,
 	aesEncrypt,
 	AesKey,
 	decryptKey,
@@ -14,14 +15,15 @@ import {
 	unauthenticatedAesDecrypt,
 } from "@tutao/tutanota-crypto"
 import { UserFacade } from "../UserFacade.js"
-import { EncryptedDbKeyBaseMetaData, EncryptedIndexerMetaData, Metadata, ObjectStoreName } from "../../search/IndexTables.js"
+import { EncryptedDbKeyBaseMetaData, EncryptedIndexerMetaData, LocalDraftDataOS, Metadata, ObjectStoreName } from "../../search/IndexTables.js"
 import { DbError } from "../../../common/error/DbError.js"
 import { checkKeyVersionConstraints, KeyLoaderFacade } from "../KeyLoaderFacade.js"
-import type { QueuedBatch } from "../../EventQueue.js"
 import { _encryptKeyWithVersionedKey, VersionedKey } from "../../crypto/CryptoWrapper.js"
 import { EntityUpdateData, isUpdateForTypeRef } from "../../../common/utils/EntityUpdateUtils"
+import * as cborg from "cborg"
+import { customTypeDecoders, customTypeEncoders } from "../../offline/OfflineStorage"
 
-const VERSION: number = 2
+const VERSION: number = 3
 const DB_KEY_PREFIX: string = "ConfigStorage"
 const ExternalImageListOS: ObjectStoreName = "ExternalAllowListOS"
 export const ConfigurationMetaDataOS: ObjectStoreName = "MetaDataOS"
@@ -43,6 +45,26 @@ export async function decryptLegacyItem(encryptedAddress: Uint8Array, key: Aes25
 	return utf8Uint8ArrayToString(unauthenticatedAesDecrypt(key, concat(iv, encryptedAddress)))
 }
 
+const LOCAL_DRAFT_VERSION: number = 1
+export type LocalDraftAddress = {
+	name: string
+	address: string
+}
+export type LocalDraftData = {
+	version: number
+
+	mailId: IdTuple | null
+	mailGroupId: Id
+
+	subject: string
+	body: string
+
+	senderAddress: string
+	to: LocalDraftAddress[]
+	cc: LocalDraftAddress[]
+	bcc: LocalDraftAddress[]
+}
+
 /**
  * A local configuration database that can be used as an alternative to DeviceConfig:
  * Ideal for cases where the configuration values should be stored encrypted,
@@ -65,6 +87,66 @@ export class ConfigurationDatabase {
 		})
 	}
 
+	async setDraftData(draftUpdateDataWithoutVersion: Omit<LocalDraftData, "version">): Promise<void> {
+		const { db, metaData } = await this.db.getAsync()
+		if (!db.indexingSupported) return
+
+		const draftUpdateData: LocalDraftData = Object.assign({}, draftUpdateDataWithoutVersion, { version: LOCAL_DRAFT_VERSION })
+
+		try {
+			const transaction = await db.createTransaction(false, [LocalDraftDataOS])
+			const encoded = cborg.encode(draftUpdateData, { typeEncoders: customTypeEncoders })
+			const encryptedData = aesEncrypt(metaData.key, encoded, metaData.iv)
+			await transaction.put(LocalDraftDataOS, "current", encryptedData) // FIXME
+		} catch (e) {
+			if (e instanceof DbError) {
+				console.error("failed to save draft:", e.message)
+				return
+			}
+			throw e
+		}
+	}
+
+	async getDraftData(): Promise<LocalDraftData | null> {
+		const { db, metaData } = await this.db.getAsync()
+		if (!db.indexingSupported) return null
+
+		try {
+			const transaction = await db.createTransaction(false, [LocalDraftDataOS])
+			const data = await transaction.get<Uint8Array>(LocalDraftDataOS, "current") // FIXME
+			if (data == null) {
+				return null
+			}
+
+			const decryptedData = aesDecrypt(metaData.key, data)
+			const encoded = cborg.decode(decryptedData, { tags: customTypeDecoders })
+
+			return encoded as LocalDraftData
+		} catch (e) {
+			if (e instanceof DbError) {
+				console.error("failed to load draft:", e.message)
+				return null
+			}
+			throw e
+		}
+	}
+
+	async clearDraftData(): Promise<void> {
+		const { db } = await this.db.getAsync()
+		if (!db.indexingSupported) return
+
+		try {
+			const transaction = await db.createTransaction(false, [LocalDraftDataOS])
+			await transaction.delete(LocalDraftDataOS, "current") // FIXME
+		} catch (e) {
+			if (e instanceof DbError) {
+				console.error("failed to load draft:", e.message)
+				return
+			}
+			throw e
+		}
+	}
+
 	async addExternalImageRule(address: string, rule: ExternalImageRule): Promise<void> {
 		const { db, metaData } = await this.db.getAsync()
 		if (!db.indexingSupported) return
@@ -96,11 +178,14 @@ export class ConfigurationDatabase {
 	async loadConfigDb(user: User, keyLoaderFacade: KeyLoaderFacade): Promise<ConfigDb> {
 		const id = this.getDbId(user._id)
 		const db = new DbFacade(VERSION, async (event, db, dbFacade) => {
+			console.log(`MIGRATING DB FOR VERSION ${event.oldVersion}`)
+
 			if (event.oldVersion === 0) {
 				db.createObjectStore(ConfigurationMetaDataOS)
 				db.createObjectStore(ExternalImageListOS, {
 					keyPath: "address",
 				})
+				db.createObjectStore(LocalDraftDataOS)
 			}
 			const metaData =
 				(await loadEncryptionMetadata(dbFacade, id, keyLoaderFacade, ConfigurationMetaDataOS)) ||
@@ -118,7 +203,12 @@ export class ConfigurationDatabase {
 					await deleteTransaction.delete(ExternalImageListOS, entry.key)
 				}
 			}
+
+			if (event.oldVersion < 3) {
+				db.createObjectStore(LocalDraftDataOS)
+			}
 		})
+
 		const metaData =
 			(await loadEncryptionMetadata(db, id, keyLoaderFacade, ConfigurationMetaDataOS)) ||
 			(await initializeDb(db, id, keyLoaderFacade, ConfigurationMetaDataOS))

src/common/api/worker/search/IndexTables.ts

@@ -10,6 +10,7 @@ export const MetaDataOS: ObjectStoreName = "MetaData"
 export const GroupDataOS: ObjectStoreName = "GroupMetaData"
 export const SearchTermSuggestionsOS: ObjectStoreName = "SearchTermSuggestions"
 export const SearchIndexWordsIndex: IndexName = "SearchIndexWords"
+export const LocalDraftDataOS: ObjectStoreName = "LocalDraftData"
 
 export const Metadata = Object.freeze({
 	userEncDbKey: "userEncDbKey",

src/common/mailFunctionality/SendMailModel.ts

@@ -82,8 +82,8 @@ import { ContactModel } from "../contactsFunctionality/ContactModel.js"
 import { getContactDisplayName } from "../contactsFunctionality/ContactUtils.js"
 import { getMailBodyText } from "../api/common/CommonMailUtils.js"
 import { KeyVerificationMismatchError } from "../api/common/error/KeyVerificationMismatchError"
-import { showMultiRecipientsKeyVerificationRecoveryDialog } from "../settings/keymanagement/KeyVerificationRecoveryDialog"
 import { EventInviteEmailType } from "../../calendar-app/calendar/view/CalendarNotificationSender"
+import type { ConfigurationDatabase } from "../api/worker/facades/lazy/ConfigurationDatabase"
 
 assertMainOrNode()
 
@@ -174,6 +174,7 @@ export class SendMailModel {
 		private readonly recipientsModel: RecipientsModel,
 		private readonly dateProvider: DateProvider,
 		private mailboxProperties: MailboxProperties,
+		private readonly configurationDatabase: ConfigurationDatabase,
 		private readonly needNewDraft: (mail: Mail) => Promise<boolean>,
 	) {
 		const userProps = logins.getUserController().props
@@ -278,6 +279,32 @@ export class SendMailModel {
 		return this.mailChangedAt > this.mailSavedAt
 	}
 
+	async clearLocalAutosave(): Promise<void> {
+		await this.configurationDatabase.clearDraftData()
+	}
+
+	async makeLocalAutosave(): Promise<void> {
+		const body = await this.getSanitizedBody()
+		const subject = this.getSubject()
+
+		const to = (await this.toRecipientsResolved()).map(({ name, address }) => ({ name, address }))
+		const cc = (await this.ccRecipientsResolved()).map(({ name, address }) => ({ name, address }))
+		const bcc = (await this.bccRecipientsResolved()).map(({ name, address }) => ({ name, address }))
+
+		await this.configurationDatabase.setDraftData({
+			body,
+			subject,
+			to,
+			cc,
+			bcc,
+			mailGroupId: this.mailboxDetails.mailGroup._id,
+			senderAddress: this.senderAddress,
+
+			// will be null if it is a new (unsaved) draft
+			mailId: this.getDraft()?._id ?? null,
+		})
+	}
+
 	/**
 	 * update the changed state of the mail.
 	 * will only be reset when saving.
@@ -693,6 +720,24 @@ export class SendMailModel {
 		})
 	}
 
+	private async createDraftData(body: string, attachments: ReadonlyArray<Attachment> | null, mailMethod: MailMethod): Promise<Mail> {
+		return this.mailFacade.createDraft({
+			subject: this.getSubject(),
+			bodyText: body,
+			senderMailAddress: this.senderAddress,
+			senderName: this.getSenderName(),
+			toRecipients: await this.toRecipientsResolved(),
+			ccRecipients: await this.ccRecipientsResolved(),
+			bccRecipients: await this.bccRecipientsResolved(),
+			conversationType: this.conversationType,
+			previousMessageId: this.previousMessageId,
+			attachments: attachments,
+			confidential: this.isConfidential(),
+			replyTos: await this.replyTosResolved(),
+			method: mailMethod,
+		})
+	}
+
 	isConfidential(): boolean {
 		return this.confidential || !this.containsExternalRecipients()
 	}
@@ -906,17 +951,7 @@ export class SendMailModel {
 			const attachments = saveAttachments ? this.attachments : null
 
 			// We also want to create new drafts for drafts edited from trash or spam folder
-			const { getHtmlSanitizer } = await import("../misc/HtmlSanitizer.js")
-			const unsanitized_body = this.getBody()
-			const body = getHtmlSanitizer().sanitizeHTML(unsanitized_body, {
-				// store the draft always with external links preserved. this reverts
-				// the draft-src and draft-srcset attribute stow.
-				blockExternalContent: false,
-				// since we're not displaying this, this is fine.
-				allowRelativeLinks: true,
-				// do not touch inline images, we just want to store this.
-				usePlaceholderForInlineImages: false,
-			}).html
+			const body = await this.getSanitizedBody()
 
 			this.draft =
 				this.draft == null || (await this.needNewDraft(this.draft))
@@ -949,6 +984,21 @@ export class SendMailModel {
 		}
 	}
 
+	private async getSanitizedBody(): Promise<string> {
+		const unsanitized_body = this.getBody()
+
+		const { getHtmlSanitizer } = await import("../misc/HtmlSanitizer.js")
+		return getHtmlSanitizer().sanitizeHTML(unsanitized_body, {
+			// store the draft always with external links preserved. this reverts
+			// the draft-src and draft-srcset attribute stow.
+			blockExternalContent: false,
+			// since we're not displaying this, this is fine.
+			allowRelativeLinks: true,
+			// do not touch inline images, we just want to store this.
+			usePlaceholderForInlineImages: false,
+		}).html
+	}
+
 	private sendApprovalMail(body: string): Promise<unknown> {
 		const listId = "---------c--"
 		const m = createApprovalMail({

src/mail-app/app.ts

@@ -39,6 +39,7 @@ import { ContactModel } from "../common/contactsFunctionality/ContactModel.js"
 import { CacheMode } from "../common/api/worker/rest/EntityRestClient"
 import { SessionType } from "../common/api/common/SessionType.js"
 import { UndoModel } from "./UndoModel"
+import { OpenLocallySavedDraftAction } from "./mail/editor/OpenLocallySavedDraftAction"
 
 assertMainOrNodeBoot()
 bootFinished()
@@ -205,6 +206,11 @@ import("./translations/en.js")
 			})
 		}
 
+		mailLocator.logins.addPostLoginAction(async () => {
+			const { OpenLocallySavedDraftAction } = await import("./mail/editor/OpenLocallySavedDraftAction.js")
+			return new OpenLocallySavedDraftAction(mailLocator.configFacade, mailLocator.mailboxModel, mailLocator.entityClient, mailLocator)
+		})
+
 		if (isDesktop()) {
 			mailLocator.logins.addPostLoginAction(async () => {
 				return {