Skip to content

A fully open source & end-to-end encrypted note taking alternative to Evernote.

core: add support for creating backups of legacy collections

Abdullah Atta7efbc666a0b0
diff --git a/packages/core/src/api/user-manager.ts b/packages/core/src/api/user-manager.ts
index 948188489..05c2800dd 100644
--- a/packages/core/src/api/user-manager.ts
+++ b/packages/core/src/api/user-manager.ts
@@ -283,6 +283,13 @@ class UserManager {
return this.db.kv().read("user");
}
+ /**
+ * @deprecated
+ */
+ getLegacyUser() {
+ return this.db.storage().read<User>("user");
+ }
+
async resetUser(removeAttachments = true) {
const token = await this.tokenManager.getAccessToken();
if (!token) return;
@@ -375,6 +382,17 @@ class UserManager {
return { key, salt: user.salt };
}
+ /**
+ * @deprecated
+ */
+ async getLegacyEncryptionKey(): Promise<SerializedKey | undefined> {
+ const user = await this.getLegacyUser();
+ if (!user) return;
+ const key = await this.db.storage().getCryptoKey();
+ if (!key) return;
+ return { key, salt: user.salt };
+ }
+
async getAttachmentsKey() {
try {
let user = await this.getUser();
diff --git a/packages/core/src/database/backup.ts b/packages/core/src/database/backup.ts
index a1668e80f..013a61a76 100644
--- a/packages/core/src/database/backup.ts
+++ b/packages/core/src/database/backup.ts
@@ -34,6 +34,7 @@ import { isCipher } from "./crypto.js";
import { migrateItem } from "../migrations";
import { DatabaseCollection } from "./index.js";
import { DefaultColors } from "../collections/colors.js";
+import { toChunks } from "../utils/array.js";
type BackupDataItem = MaybeDeletedItem<Item> | string[];
type BackupPlatform = "web" | "mobile" | "node";
@@ -157,7 +158,94 @@ export default class Backup {
await this.db.kv().write("lastBackupTime", Date.now());
}
+ /**
+ * @deprecated
+ */
+ async *exportLegacy(type: BackupPlatform, encrypt = false) {
+ if (!validTypes.some((t) => t === type))
+ throw new Error("Invalid type. It must be one of 'mobile' or 'web'.");
+ if (encrypt && !(await this.db.user.getLegacyUser()))
+ throw new Error("Please login to create encrypted backups.");
+
+ const key = await this.db.user.getLegacyEncryptionKey();
+ if (encrypt && !key) throw new Error("No encryption key found.");
+
+ const keys = await this.db.storage().getAllKeys();
+ const chunks = toChunks(keys, 20);
+ let buffer: string[] = [];
+ let bufferLength = 0;
+ const MAX_CHUNK_SIZE = 10 * 1024 * 1024;
+ let chunkIndex = 0;
+
+ while (chunks.length > 0) {
+ const chunk = chunks.pop();
+ if (!chunk) break;
+
+ const items = await this.db.storage().readMulti(chunk);
+ items.forEach(([id, item]) => {
+ const isDeleted =
+ item &&
+ typeof item === "object" &&
+ "deleted" in item &&
+ !("type" in item);
+
+ if (
+ !item ||
+ invalidKeys.includes(id) ||
+ isDeleted ||
+ id.startsWith("_uk_")
+ )
+ return;
+
+ const data = JSON.stringify(item);
+ buffer.push(data);
+ bufferLength += data.length;
+ });
+
+ if (bufferLength >= MAX_CHUNK_SIZE || chunks.length === 0) {
+ let itemsJSON = `[${buffer.join(",")}]`;
+
+ buffer = [];
+ bufferLength = 0;
+
+ itemsJSON = await this.db.compressor().compress(itemsJSON);
+
+ const hash = SparkMD5.hash(itemsJSON);
+
+ if (encrypt && key)
+ itemsJSON = JSON.stringify(
+ await this.db.storage().encrypt(key, itemsJSON)
+ );
+ else itemsJSON = JSON.stringify(itemsJSON);
+
+ yield {
+ path: `${chunkIndex++}-${encrypt ? "encrypted" : "plain"}-${hash}`,
+ data: `{
+"version": ${CURRENT_DATABASE_VERSION},
+"type": "${type}",
+"date": ${Date.now()},
+"data": ${itemsJSON},
+"hash": "${hash}",
+"hash_type": "md5",
+"compressed": true,
+"encrypted": ${encrypt ? "true" : "false"}
+}`
+ };
+ }
+ }
+
+ if (bufferLength > 0 || buffer.length > 0)
+ throw new Error("Buffer not empty.");
+
+ await this.updateBackupTime();
+ }
+
async *export(type: BackupPlatform, encrypt = false) {
+ if (this.db.migrations.version === 5.9) {
+ yield* this.exportLegacy(type, encrypt);
+ return;
+ }
+
if (!validTypes.some((t) => t === type))
throw new Error("Invalid type. It must be one of 'mobile' or 'web'.");
if (encrypt && !(await this.db.user.getUser()))