manually delete indexeddb

.github/workflows/auto-build.yml

@@ -38,3 +38,4 @@ jobs:
           path: |
             main.js
             manifest.json
+            styles.css

docs/algorithm.md

@@ -14,16 +14,16 @@ Assuming all sources are reliable.
 
 We list all combinations mutually exclusive and collectively exhaustive.
 
-| ID   | Remote Files | Local files | Local delete rename history | Extra                                                        | Decision                                                     |
+| ID  | Remote Files | Local files | Local delete rename history | Extra                                                                         | Decision                                                                                                 |
-| ---- | ------------ | ----------- | --------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| --- | ------------ | ----------- | --------------------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
-| 1    | exist        | exist       | ignore                      | mtime_remote > mtime_local                                   | download remote file, create local folder if not exists, clear local history if exists |
+| 1   | exist        | exist       | ignore                      | mtime_remote > mtime_local                                                    | download remote file, create local folder if not exists, clear local history if exists                   |
-| 2    | exist        | exist       | ignore                      | mtime_remote < mtime_local                                   | upload local file, create remote folder if not exists, clear local history if exists |
+| 2   | exist        | exist       | ignore                      | mtime_remote < mtime_local                                                    | upload local file, create remote folder if not exists, clear local history if exists                     |
-| 3    | exist        | exist       | ignore                      | mtime_remote === mtime_local && password === "" && size_remote === size_local | clear local history if exists (the file was synced and no changes after last sync) |
+| 3   | exist        | exist       | ignore                      | mtime_remote === mtime_local && password === "" && size_remote === size_local | clear local history if exists (the file was synced and no changes after last sync)                       |
-| 4    | exist        | exist       | ignore                      | mtime_remote === mtime_local && password === "" && size_remote !== size_local | upload local file, clear local history if exists (we always prefer local to remote) |
+| 4   | exist        | exist       | ignore                      | mtime_remote === mtime_local && password === "" && size_remote !== size_local | upload local file, clear local history if exists (we always prefer local to remote)                      |
-| 5    | exist        | exist       | ignore                      | mtime_remote === mtime_local && password !== ""              | clear local history if exists (in encryption mode, file sizes are unequal. we can only rely on mtime(s)) |
+| 5   | exist        | exist       | ignore                      | mtime_remote === mtime_local && password !== ""                               | clear local history if exists (in encryption mode, file sizes are unequal. we can only rely on mtime(s)) |
-| 6    | exist        | exist       | ignore                      | If local is a folder. mtime_local === undefined              | clear local history if exists. TODO: what if a folder and a previous file share the same name? |
+| 6   | exist        | exist       | ignore                      | If local is a folder. mtime_local === undefined                               | clear local history if exists. TODO: what if a folder and a previous file share the same name?           |
-| 7    | exist        | not exist   | exist                       | mtime_remote >= delete_time_local                            | download remote file, create folder if not exists            |
+| 7   | exist        | not exist   | exist                       | mtime_remote >= delete_time_local                                             | download remote file, create folder if not exists                                                        |
-| 8    | exist        | not exist   | exist                       | mtime_remote < delete_time_local                             | delete remote file, clear local history                      |
+| 8   | exist        | not exist   | exist                       | mtime_remote < delete_time_local                                              | delete remote file, clear local history                                                                  |
-| 9    | exist        | not exist   | not exist                   |                                                              | download remote file, create folder if not exists            |
+| 9   | exist        | not exist   | not exist                   |                                                                               | download remote file, create folder if not exists                                                        |
-| 10   | not exist    | exist       | ignore                      | local may be folder or file                                  | upload local files recursively, create remote folder if not exists, clear local history if exists |
+| 10  | not exist    | exist       | ignore                      | local may be folder or file                                                   | upload local files recursively, create remote folder if not exists, clear local history if exists        |
-| 11   | not exist    | not exist   | ignore                      |                                                              | clear local history if exists                                |
+| 11  | not exist    | not exist   | ignore                      |                                                                               | clear local history if exists                                                                            |

manifest.json

@@ -1,7 +1,7 @@
 {
-  "id": "obsdian-save-remote",
+  "id": "obsidian-save-remote",
   "name": "Save remote",
-  "version": "0.0.10",
+  "version": "0.0.15",
   "minAppVersion": "0.12.15",
   "description": "This is yet another plugin allowing users to sync notes between local device and the cloud.",
   "author": "fyears",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "obsidian-save-remote",
-  "version": "0.0.10",
+  "version": "0.0.15",
   "description": "This is yet another sync plugin for Obsidian app.",
   "scripts": {
     "dev": "webpack --mode development --watch",
@@ -15,10 +15,12 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@types/chai": "^4.2.22",
+    "@types/chai-as-promised": "^7.1.4",
     "@types/mime-types": "^2.1.1",
     "@types/mocha": "^9.0.0",
     "@types/node": "^14.14.37",
     "chai": "^4.3.4",
+    "chai-as-promised": "^7.1.1",
     "cross-env": "^7.0.3",
     "mocha": "^9.1.3",
     "prettier": "^2.4.1",
@@ -33,12 +35,13 @@
   },
   "dependencies": {
     "@aws-sdk/client-s3": "^3.37.0",
+    "@aws-sdk/lib-storage": "^3.40.1",
     "@aws-sdk/signature-v4-crt": "^3.37.0",
     "acorn": "^8.5.0",
     "aws-crt": "^1.10.1",
     "buffer": "^6.0.3",
     "codemirror": "^5.63.1",
-    "lovefield-ts": "^0.7.0",
+    "localforage": "^1.10.0",
     "mime-types": "^2.1.33",
     "obsidian": "^0.12.0",
     "path-browserify": "^1.0.1",
@@ -47,6 +50,7 @@
     "rimraf": "^3.0.2",
     "stream-browserify": "^3.0.0",
     "webdav": "^4.7.0",
-    "webdav-fs": "^4.0.0"
+    "webdav-fs": "^4.0.0",
+    "xregexp": "^5.1.0"
   }
 }

src/debugMode.ts

@@ -1,22 +1,14 @@
 import { TAbstractFile, TFolder, TFile, Vault } from "obsidian";
 
-import * as lf from "lovefield-ts/dist/es6/lf.js";
-
 import type { SyncPlanType } from "./sync";
-import {
+import { readAllSyncPlanRecordTexts } from "./localdb";
-  insertSyncPlanRecord,
+import type { InternalDBs } from "./localdb";
-  clearAllSyncPlanRecords,
-  readAllSyncPlanRecordTexts,
-} from "./localdb";
 import { mkdirpInVault } from "./misc";
 
 const DEFAULT_DEBUG_FOLDER = "_debug_save_remote/";
 const DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX = "sync_plans_hist_exported_on_";
 
-export const exportSyncPlansToFiles = async (
+export const exportSyncPlansToFiles = async (db: InternalDBs, vault: Vault) => {
-  db: lf.DatabaseConnection,
-  vault: Vault
-) => {
   console.log("exporting");
   await mkdirpInVault(DEFAULT_DEBUG_FOLDER, vault);
   const records = await readAllSyncPlanRecordTexts(db);

src/encrypt.ts

@@ -8,6 +8,9 @@ import {
 
 const DEFAULT_ITER = 10000;
 
+// base32.stringify(Buffer.from('Salted__'))
+export const MAGIC_ENCRYPTED_PREFIX_BASE32 = "KNQWY5DFMRPV";
+
 const getKeyIVFromPassword = async (
   salt: Uint8Array,
   password: string,

src/localdb.ts

@@ -1,12 +1,14 @@
-import * as lf from "lovefield-ts/dist/es6/lf.js";
+import localforage from "localforage";
 import { TAbstractFile, TFile, TFolder } from "obsidian";
 
 import type { SUPPORTED_SERVICES_TYPE } from "./misc";
 import type { SyncPlanType } from "./sync";
 
-export type DatabaseConnection = lf.DatabaseConnection;
+export type LocalForage = typeof localforage;
 
+export const DEFAULT_DB_VERSION_NUMBER: number = 20211114;
 export const DEFAULT_DB_NAME = "saveremotedb";
+export const DEFAULT_TBL_VERSION = "schemaversion";
 export const DEFAULT_TBL_DELETE_HISTORY = "filefolderoperationhistory";
 export const DEFAULT_TBL_SYNC_MAPPING = "syncmetadatahistory";
 export const DEFAULT_SYNC_PLANS_HISTORY = "syncplanshistory";
@@ -16,84 +18,75 @@ export interface FileFolderHistoryRecord {
   ctime: number;
   mtime: number;
   size: number;
-  action_when: number;
+  actionWhen: number;
-  action_type: "delete" | "rename";
+  actionType: "delete" | "rename";
-  key_type: "folder" | "file";
+  keyType: "folder" | "file";
-  rename_to: string;
+  renameTo: string;
 }
 
-export interface SyncMetaMappingRecord {
+interface SyncMetaMappingRecord {
-  local_key: string;
+  localKey: string;
-  remote_key: string;
+  remoteKey: string;
-  local_size: number;
+  localSize: number;
-  remote_size: number;
+  remoteSize: number;
-  local_mtime: number;
+  localMtime: number;
-  remote_mtime: number;
+  remoteMtime: number;
-  remote_extra_key: string;
+  remoteExtraKey: string;
-  remote_type: SUPPORTED_SERVICES_TYPE;
+  remoteType: SUPPORTED_SERVICES_TYPE;
-  key_type: "folder" | "file";
+  keyType: "folder" | "file";
 }
 
 interface SyncPlanRecord {
   ts: number;
-  remote_type: string;
+  remoteType: string;
-  sync_plan: string;
+  syncPlan: string;
+}
+
+export interface InternalDBs {
+  versionTbl: LocalForage;
+  deleteHistoryTbl: LocalForage;
+  syncMappingTbl: LocalForage;
+  syncPlansTbl: LocalForage;
 }
 
 export const prepareDBs = async () => {
-  const schemaBuilder = lf.schema.create(DEFAULT_DB_NAME, 1);
+  const db = {
-  schemaBuilder
+    versionTbl: localforage.createInstance({
-    .createTable(DEFAULT_TBL_DELETE_HISTORY)
+      name: DEFAULT_DB_NAME,
-    .addColumn("id", lf.Type.INTEGER)
+      storeName: DEFAULT_TBL_VERSION,
-    .addColumn("key", lf.Type.STRING)
+    }),
-    .addColumn("ctime", lf.Type.INTEGER)
+    deleteHistoryTbl: localforage.createInstance({
-    .addColumn("mtime", lf.Type.INTEGER)
+      name: DEFAULT_DB_NAME,
-    .addColumn("size", lf.Type.INTEGER)
+      storeName: DEFAULT_TBL_DELETE_HISTORY,
-    .addColumn("action_when", lf.Type.INTEGER)
+    }),
-    .addColumn("action_type", lf.Type.STRING)
+    syncMappingTbl: localforage.createInstance({
-    .addColumn("key_type", lf.Type.STRING)
+      name: DEFAULT_DB_NAME,
-    .addPrimaryKey(["id"], true)
+      storeName: DEFAULT_TBL_SYNC_MAPPING,
-    .addIndex("idxKey", ["key"]);
+    }),
+    syncPlansTbl: localforage.createInstance({
+      name: DEFAULT_DB_NAME,
+      storeName: DEFAULT_SYNC_PLANS_HISTORY,
+    }),
+  } as InternalDBs;
 
-  schemaBuilder
+  const originalVersion = (await db.versionTbl.getItem("version")) as number;
-    .createTable(DEFAULT_TBL_SYNC_MAPPING)
+  if (originalVersion === null) {
-    .addColumn("id", lf.Type.INTEGER)
+    await db.versionTbl.setItem("version", DEFAULT_DB_VERSION_NUMBER);
-    .addColumn("local_key", lf.Type.STRING)
+  } else if (originalVersion === DEFAULT_DB_VERSION_NUMBER) {
-    .addColumn("remote_key", lf.Type.STRING)
+    // do nothing
-    .addColumn("local_size", lf.Type.INTEGER)
+  } else {
-    .addColumn("remote_size", lf.Type.INTEGER)
+    await migrateDBs(db, originalVersion, DEFAULT_DB_VERSION_NUMBER);
-    .addColumn("local_mtime", lf.Type.INTEGER)
+  }
-    .addColumn("remote_mtime", lf.Type.INTEGER)
-    .addColumn("key_type", lf.Type.STRING)
-    .addColumn("remote_extra_key", lf.Type.STRING)
-    .addColumn("remote_type", lf.Type.STRING)
-    .addNullable([
-      "remote_extra_key",
-      "remote_mtime",
-      "remote_size",
-      "local_mtime",
-    ])
-    .addPrimaryKey(["id"], true)
-    .addIndex("idxkey", ["local_key", "remote_key"]);
 
-  schemaBuilder
-    .createTable(DEFAULT_SYNC_PLANS_HISTORY)
-    .addColumn("id", lf.Type.INTEGER)
-    .addColumn("ts", lf.Type.INTEGER)
-    .addColumn("remote_type", lf.Type.STRING)
-    .addColumn("sync_plan", lf.Type.STRING)
-    .addPrimaryKey(["id"], true)
-    .addIndex("tskey", ["ts"]);
-
-  const db = await schemaBuilder.connect({
-    storeType: lf.DataStoreType.INDEXED_DB,
-  });
   console.log("db connected");
   return db;
 };
 
-export const destroyDBs = async (db: lf.DatabaseConnection) => {
+export const destroyDBs = async () => {
-  db.close();
+  // await localforage.dropInstance({
+  //   name: DEFAULT_DB_NAME,
+  // });
+  // console.log("db deleted");
   const req = indexedDB.deleteDatabase(DEFAULT_DB_NAME);
   req.onsuccess = (event) => {
     console.log("db deleted");
@@ -107,37 +100,34 @@ export const destroyDBs = async (db: lf.DatabaseConnection) => {
   };
 };
 
-export const loadDeleteRenameHistoryTable = async (
+const migrateDBs = async (db: InternalDBs, oldVer: number, newVer: number) => {
-  db: lf.DatabaseConnection
+  if (oldVer === newVer) {
-) => {
+    return;
-  const schema = db.getSchema().table(DEFAULT_TBL_DELETE_HISTORY);
+  }
-  const tbl = db.getSchema().table(DEFAULT_TBL_DELETE_HISTORY);
+  // not implemented
+  throw Error(`not supported internal db changes from ${oldVer} to ${newVer}`);
+};
 
-  const records = await db
+export const loadDeleteRenameHistoryTable = async (db: InternalDBs) => {
-    .select()
+  const records = [] as FileFolderHistoryRecord[];
-    .from(schema)
+  await db.deleteHistoryTbl.iterate((value, key, iterationNumber) => {
-    .orderBy(schema.col("action_when"), lf.Order.ASC)
+    records.push(value as FileFolderHistoryRecord);
-    .exec();
+  });
-
+  records.sort((a, b) => a.actionWhen - b.actionWhen); // ascending
-  return records as FileFolderHistoryRecord[];
+  return records;
 };
 
 export const clearDeleteRenameHistoryOfKey = async (
-  db: lf.DatabaseConnection,
+  db: InternalDBs,
   key: string
 ) => {
-  const schema = db.getSchema().table(DEFAULT_TBL_DELETE_HISTORY);
+  await db.deleteHistoryTbl.removeItem(key);
-  const tbl = db.getSchema().table(DEFAULT_TBL_DELETE_HISTORY);
-
-  await db.delete().from(tbl).where(tbl.col("key").eq(key)).exec();
 };
 
 export const insertDeleteRecord = async (
-  db: lf.DatabaseConnection,
+  db: InternalDBs,
   fileOrFolder: TAbstractFile
 ) => {
-  const schema = db.getSchema().table(DEFAULT_TBL_DELETE_HISTORY);
-  const tbl = db.getSchema().table(DEFAULT_TBL_DELETE_HISTORY);
   // console.log(fileOrFolder);
   let k: FileFolderHistoryRecord;
   if (fileOrFolder instanceof TFile) {
@@ -146,10 +136,10 @@ export const insertDeleteRecord = async (
       ctime: fileOrFolder.stat.ctime,
       mtime: fileOrFolder.stat.mtime,
       size: fileOrFolder.stat.size,
-      action_when: Date.now(),
+      actionWhen: Date.now(),
-      action_type: "delete",
+      actionType: "delete",
-      key_type: "file",
+      keyType: "file",
-      rename_to: "",
+      renameTo: "",
     };
   } else if (fileOrFolder instanceof TFolder) {
     // key should endswith "/"
@@ -161,23 +151,20 @@ export const insertDeleteRecord = async (
       ctime: 0,
       mtime: 0,
       size: 0,
-      action_when: Date.now(),
+      actionWhen: Date.now(),
-      action_type: "delete",
+      actionType: "delete",
-      key_type: "folder",
+      keyType: "folder",
-      rename_to: "",
+      renameTo: "",
     };
   }
-  const row = tbl.createRow(k);
+  await db.deleteHistoryTbl.setItem(k.key, k);
-  await db.insertOrReplace().into(tbl).values([row]).exec();
 };
 
 export const insertRenameRecord = async (
-  db: lf.DatabaseConnection,
+  db: InternalDBs,
   fileOrFolder: TAbstractFile,
   oldPath: string
 ) => {
-  const schema = db.getSchema().table(DEFAULT_TBL_DELETE_HISTORY);
-  const tbl = db.getSchema().table(DEFAULT_TBL_DELETE_HISTORY);
   // console.log(fileOrFolder);
   let k: FileFolderHistoryRecord;
   if (fileOrFolder instanceof TFile) {
@@ -186,10 +173,10 @@ export const insertRenameRecord = async (
       ctime: fileOrFolder.stat.ctime,
       mtime: fileOrFolder.stat.mtime,
       size: fileOrFolder.stat.size,
-      action_when: Date.now(),
+      actionWhen: Date.now(),
-      action_type: "rename",
+      actionType: "rename",
-      key_type: "file",
+      keyType: "file",
-      rename_to: fileOrFolder.path,
+      renameTo: fileOrFolder.path,
     };
   } else if (fileOrFolder instanceof TFolder) {
     const key = oldPath.endsWith("/") ? oldPath : `${oldPath}/`;
@@ -201,25 +188,17 @@ export const insertRenameRecord = async (
       ctime: 0,
       mtime: 0,
       size: 0,
-      action_when: Date.now(),
+      actionWhen: Date.now(),
-      action_type: "rename",
+      actionType: "rename",
-      key_type: "folder",
+      keyType: "folder",
-      rename_to: renameTo,
+      renameTo: renameTo,
     };
   }
-  const row = tbl.createRow(k);
+  await db.deleteHistoryTbl.setItem(k.key, k);
-  await db.insertOrReplace().into(tbl).values([row]).exec();
-};
-
-export const getAllDeleteRenameRecords = async (db: lf.DatabaseConnection) => {
-  const schema = db.getSchema().table(DEFAULT_TBL_DELETE_HISTORY);
-  const res1 = await db.select().from(schema).exec();
-  const res2 = res1 as FileFolderHistoryRecord[];
-  return res2;
 };
 
 export const upsertSyncMetaMappingDataS3 = async (
-  db: lf.DatabaseConnection,
+  db: InternalDBs,
   localKey: string,
   localMTime: number,
   localSize: number,
@@ -228,84 +207,78 @@ export const upsertSyncMetaMappingDataS3 = async (
   remoteSize: number,
   remoteExtraKey: string /* ETag from s3 */
 ) => {
-  const schema = db.getSchema().table(DEFAULT_TBL_SYNC_MAPPING);
   const aggregratedInfo: SyncMetaMappingRecord = {
-    local_key: localKey,
+    localKey: localKey,
-    local_mtime: localMTime,
+    localMtime: localMTime,
-    local_size: localSize,
+    localSize: localSize,
-    remote_key: remoteKey,
+    remoteKey: remoteKey,
-    remote_mtime: remoteMTime,
+    remoteMtime: remoteMTime,
-    remote_size: remoteSize,
+    remoteSize: remoteSize,
-    remote_extra_key: remoteExtraKey,
+    remoteExtraKey: remoteExtraKey,
-    remote_type: "s3",
+    remoteType: "s3",
-    key_type: localKey.endsWith("/") ? "folder" : "file",
+    keyType: localKey.endsWith("/") ? "folder" : "file",
   };
-  const row = schema.createRow(aggregratedInfo);
+  await db.syncMappingTbl.setItem(remoteKey, aggregratedInfo);
-  await db.insertOrReplace().into(schema).values([row]).exec();
 };
 
 export const getSyncMetaMappingByRemoteKeyS3 = async (
-  db: lf.DatabaseConnection,
+  db: InternalDBs,
   remoteKey: string,
   remoteMTime: number,
   remoteExtraKey: string
 ) => {
-  const schema = db.getSchema().table(DEFAULT_TBL_SYNC_MAPPING);
+  const potentialItem = (await db.syncMappingTbl.getItem(
-  const tbl = db.getSchema().table(DEFAULT_TBL_SYNC_MAPPING);
+    remoteKey
-  const res = (await db
+  )) as SyncMetaMappingRecord;
-    .select()
-    .from(tbl)
-    .where(
-      lf.op.and(
-        tbl.col("remote_key").eq(remoteKey),
-        tbl.col("remote_mtime").eq(remoteMTime),
-        tbl.col("remote_extra_key").eq(remoteExtraKey),
-        tbl.col("remote_type").eq("s3")
-      )
-    )
-    .exec()) as SyncMetaMappingRecord[];
 
-  if (res.length === 1) {
+  if (potentialItem === null) {
-    return res[0];
+    // no result was found
-  }
-
-  if (res.length === 0) {
     return undefined;
   }
 
-  throw Error("something bad in sync meta mapping!");
+  if (
+    potentialItem.remoteKey === remoteKey &&
+    potentialItem.remoteMtime === remoteMTime &&
+    potentialItem.remoteExtraKey === remoteExtraKey &&
+    potentialItem.remoteType === "s3"
+  ) {
+    // the result was found
+    return potentialItem;
+  } else {
+    return undefined;
+  }
+};
+
+export const clearAllSyncMetaMapping = async (db: InternalDBs) => {
+  await db.syncMappingTbl.clear();
 };
 
 export const insertSyncPlanRecord = async (
-  db: lf.DatabaseConnection,
+  db: InternalDBs,
   syncPlan: SyncPlanType
 ) => {
-  const schema = db.getSchema().table(DEFAULT_SYNC_PLANS_HISTORY);
+  const record = {
-  const row = schema.createRow({
     ts: syncPlan.ts,
-    remote_type: syncPlan.remoteType,
+    remoteType: syncPlan.remoteType,
-    sync_plan: JSON.stringify(syncPlan, null, 2),
+    syncPlan: JSON.stringify(syncPlan /* directly stringify */, null, 2),
-  } as SyncPlanRecord);
+  } as SyncPlanRecord;
-  await db.insertOrReplace().into(schema).values([row]).exec();
+  await db.syncPlansTbl.setItem(`${syncPlan.ts}`, record);
 };
 
-export const clearAllSyncPlanRecords = async (db: lf.DatabaseConnection) => {
+export const clearAllSyncPlanRecords = async (db: InternalDBs) => {
-  const tbl = db.getSchema().table(DEFAULT_SYNC_PLANS_HISTORY);
+  await db.syncPlansTbl.clear();
-  await db.delete().from(tbl).exec();
 };
 
-export const readAllSyncPlanRecordTexts = async (db: lf.DatabaseConnection) => {
+export const readAllSyncPlanRecordTexts = async (db: InternalDBs) => {
-  const schema = db.getSchema().table(DEFAULT_SYNC_PLANS_HISTORY);
+  const records = [] as SyncPlanRecord[];
-
+  await db.syncPlansTbl.iterate((value, key, iterationNumber) => {
-  const records = (await db
+    records.push(value as SyncPlanRecord);
-    .select()
+  });
-    .from(schema)
+  records.sort((a, b) => -(a.ts - b.ts)); // descending
-    .orderBy(schema.col("ts"), lf.Order.DESC)
-    .exec()) as SyncPlanRecord[];
 
   if (records === undefined) {
     return [] as string[];
   } else {
-    return records.map((x) => x.sync_plan);
+    return records.map((x) => x.syncPlan);
   }
 };

src/main.ts

@@ -11,20 +11,27 @@ import {
   TFolder,
 } from "obsidian";
 import * as CodeMirror from "codemirror";
-import { clearAllSyncPlanRecords, DatabaseConnection } from "./localdb";
 import {
   prepareDBs,
   destroyDBs,
   loadDeleteRenameHistoryTable,
+  clearAllSyncPlanRecords,
+  clearAllSyncMetaMapping,
   insertDeleteRecord,
   insertRenameRecord,
-  getAllDeleteRenameRecords,
   insertSyncPlanRecord,
 } from "./localdb";
+import type { InternalDBs } from "./localdb";
 
-import type { SyncStatusType } from "./sync";
+import type { SyncStatusType, PasswordCheckType } from "./sync";
-import { getSyncPlan, doActualSync } from "./sync";
+import { isPasswordOk, getSyncPlan, doActualSync } from "./sync";
-import { DEFAULT_S3_CONFIG, getS3Client, listFromRemote, S3Config } from "./s3";
+import {
+  DEFAULT_S3_CONFIG,
+  getS3Client,
+  listFromRemote,
+  S3Config,
+  checkS3Connectivity,
+} from "./s3";
 import { exportSyncPlansToFiles } from "./debugMode";
 
 interface SaveRemotePluginSettings {
@@ -40,7 +47,7 @@ const DEFAULT_SETTINGS: SaveRemotePluginSettings = {
 export default class SaveRemotePlugin extends Plugin {
   settings: SaveRemotePluginSettings;
   cm: CodeMirror.Editor;
-  db: DatabaseConnection;
+  db: InternalDBs;
   syncStatus: SyncStatusType;
 
   async onload() {
@@ -71,6 +78,7 @@ export default class SaveRemotePlugin extends Plugin {
       }
 
       try {
+        //console.log(`huh ${this.settings.password}`)
         new Notice("1/6 Save Remote Sync Preparing");
         this.syncStatus = "preparing";
 
@@ -87,7 +95,18 @@ export default class SaveRemotePlugin extends Plugin {
         // console.log(local);
         // console.log(localHistory);
 
-        new Notice("4/6 Starting to generate sync plan.");
+        new Notice("4/7 Checking password correct or not.");
+        this.syncStatus = "checking_password";
+        const passwordCheckResult = await isPasswordOk(
+          remoteRsp.Contents,
+          this.settings.password
+        );
+        if (!passwordCheckResult.ok) {
+          new Notice("something goes wrong while checking password");
+          throw Error(passwordCheckResult.reason);
+        }
+
+        new Notice("5/7 Starting to generate sync plan.");
         this.syncStatus = "generating_plan";
         const syncPlan = await getSyncPlan(
           remoteRsp.Contents,
@@ -102,7 +121,7 @@ export default class SaveRemotePlugin extends Plugin {
         // The operations above are read only and kind of safe.
         // The operations below begins to write or delete (!!!) something.
 
-        new Notice("5/6 Save Remote Sync data exchanging!");
+        new Notice("6/7 Save Remote Sync data exchanging!");
 
         this.syncStatus = "syncing";
         await doActualSync(
@@ -114,7 +133,7 @@ export default class SaveRemotePlugin extends Plugin {
           this.settings.password
         );
 
-        new Notice("6/6 Save Remote finish!");
+        new Notice("7/7 Save Remote finish!");
         this.syncStatus = "finish";
         this.syncStatus = "idle";
       } catch (error) {
@@ -122,7 +141,7 @@ export default class SaveRemotePlugin extends Plugin {
         console.log(msg);
         console.log(error);
         new Notice(msg);
-        new Notice(error);
+        new Notice(error.message);
         this.syncStatus = "idle";
       }
     });
@@ -165,6 +184,64 @@ export default class SaveRemotePlugin extends Plugin {
   }
 }
 
+export class PasswordModal extends Modal {
+  plugin: SaveRemotePlugin;
+  newPassword: string;
+  constructor(app: App, plugin: SaveRemotePlugin, newPassword: string) {
+    super(app);
+    this.plugin = plugin;
+    this.newPassword = newPassword;
+  }
+
+  onOpen() {
+    let { contentEl } = this;
+    // contentEl.setText("Add Or change password.");
+    contentEl.createEl("h2", { text: "Hold on and PLEASE READ ON..." });
+    contentEl.createEl("p", {
+      text: "If the field is not empty, files are enctrypted using the password locally before sent to remote.",
+    });
+    contentEl.createEl("p", {
+      text: "If the field is empty, then no password is used, and files would be sent without encryption.",
+    });
+
+    contentEl.createEl("p", {
+      text: "Attention 1/4: The password itself is stored in PLAIN TEXT LOCALLY and would not be sent to remote by this plugin.",
+    });
+    contentEl.createEl("p", {
+      text: "Attention 2/4: Non-empty file contents are encrypted using openssl format. File/directory path are also encrypted then applied base32. BUT, some metadata such as file sizes and directory structures are not encrypted or can be easily guessed, and directory path are stored as 0-byte-size object remotely.",
+    });
+    contentEl.createEl("p", {
+      text: "Attention 3/4: Before changing password, you should make sure the remote store (s3/webdav/...) IS EMPTY, or REMOTE FILES WERE ENCRYPTED BY THAT NEW PASSWORD. OTHERWISE SOMETHING BAD WOULD HAPPEN!",
+    });
+    contentEl.createEl("p", {
+      text: "Attention 4/4: The longer the password, the better.",
+    });
+
+    new Setting(contentEl)
+      .addButton((button) => {
+        button.setButtonText("The Second Confirm to change password.");
+        button.onClick(async () => {
+          this.plugin.settings.password = this.newPassword;
+          await this.plugin.saveSettings();
+          new Notice("New password saved!");
+          this.close();
+        });
+        button.setClass("password_second_confirm");
+      })
+      .addButton((button) => {
+        button.setButtonText("Go Back");
+        button.onClick(() => {
+          this.close();
+        });
+      });
+  }
+
+  onClose() {
+    let { contentEl } = this;
+    contentEl.empty();
+  }
+}
+
 class SaveRemoteSettingTab extends PluginSettingTab {
   plugin: SaveRemotePlugin;
 
@@ -247,23 +324,57 @@ class SaveRemoteSettingTab extends PluginSettingTab {
           })
       );
 
+    new Setting(containerEl)
+      .setName("check connectivity")
+      .setDesc("check connectivity")
+      .addButton(async (button) => {
+        button.setButtonText("Check");
+        button.onClick(async () => {
+          new Notice("Checking...");
+          const s3Client = getS3Client(this.plugin.settings.s3);
+          const res = await checkS3Connectivity(
+            s3Client,
+            this.plugin.settings.s3
+          );
+          if (res) {
+            new Notice("Great! The bucket can be accessed.");
+          } else {
+            new Notice("The S3 bucket cannot be reached.");
+          }
+        });
+      });
+
     containerEl.createEl("h2", { text: "General" });
+
+    let newPassword = `${this.plugin.settings.password}`;
     new Setting(containerEl)
       .setName("encryption password")
-      .setDesc("Password for E2E encryption. Empty for no password.")
+      .setDesc(
+        'Password for E2E encryption. Empty for no password. You need to click "Confirm".'
+      )
       .addText((text) =>
         text
           .setPlaceholder("")
           .setValue(`${this.plugin.settings.password}`)
           .onChange(async (value) => {
-            this.plugin.settings.password = value.trim();
+            newPassword = value.trim();
-            await this.plugin.saveSettings();
           })
-      );
+      )
+      .addButton(async (button) => {
+        button.setButtonText("Confirm");
+        button.onClick(async () => {
+          new PasswordModal(this.app, this.plugin, newPassword).open();
+        });
+      });
 
     containerEl.createEl("h2", { text: "Debug" });
 
-    new Setting(containerEl)
+    const syncPlanDiv = containerEl.createEl("div");
+    syncPlanDiv.createEl("p", {
+      text: "Sync plans are created every time after you trigger sync and before the actual sync. Useful to know what would actually happen in those sync.",
+    });
+
+    new Setting(syncPlanDiv)
       .setName("export sync plans")
       .setDesc("export sync plans")
       .addButton(async (button) => {
@@ -274,7 +385,7 @@ class SaveRemoteSettingTab extends PluginSettingTab {
         });
       });
 
-    new Setting(containerEl)
+    new Setting(syncPlanDiv)
       .setName("delete sync plans history in db")
       .setDesc("delete sync plans history in db")
       .addButton(async (button) => {
@@ -284,5 +395,38 @@ class SaveRemoteSettingTab extends PluginSettingTab {
           new Notice("sync plans history (in db) deleted");
         });
       });
+
+    const syncMappingDiv = containerEl.createEl("div");
+    syncMappingDiv.createEl("p", {
+      text: "Sync mappings history stores the actual LOCAL last modified time of the REMOTE objects. Clearing it may cause unnecessary data exchanges in next-time sync.",
+    });
+
+    new Setting(syncMappingDiv)
+      .setName("delete sync mappings history in db")
+      .setDesc("delete sync mappings history in db")
+      .addButton(async (button) => {
+        button.setButtonText("Delete Sync Mappings");
+        button.onClick(async () => {
+          await clearAllSyncMetaMapping(this.plugin.db);
+          new Notice("sync mappings history (in local db) deleted");
+        });
+      });
+
+    const dbsResetDiv = containerEl.createEl("div");
+    syncMappingDiv.createEl("p", {
+      text: "Reset local internal caches/databases (for debugging purposes). You would want to reload the plugin after resetting this. This option will not empty the {s3, password...} settings.",
+    });
+    new Setting(syncMappingDiv)
+      .setName("reset local internal cache/databases")
+      .setDesc("reset local internal cache/databases")
+      .addButton(async (button) => {
+        button.setButtonText("Reset");
+        button.onClick(async () => {
+          await destroyDBs();
+          new Notice(
+            "Local internal cache/databases deleted. Please manually reload the plugin."
+          );
+        });
+      });
   }
 }

src/misc.ts

@@ -2,6 +2,7 @@ import { Vault } from "obsidian";
 import * as path from "path";
 
 import { base32 } from "rfc4648";
+import XRegExp from "xregexp";
 
 export type SUPPORTED_SERVICES_TYPE = "s3" | "webdav" | "ftp";
 
@@ -111,3 +112,21 @@ export const hexStringToTypedArray = (hex: string) => {
 export const base64ToBase32 = (a: string) => {
   return base32.stringify(Buffer.from(a, "base64"));
 };
+
+/**
+ * iOS Safari could decrypt string with invalid password!
+ * So we need an extra way to test the decrypted result.
+ * One simple way is testing the result are "valid", printable chars or not.
+ *
+ * https://stackoverflow.com/questions/6198986
+ * https://www.regular-expressions.info/unicode.html
+ * Manual test shows that emojis like '🍎' match '\\p{Cs}',
+ * so we need to write the regrex in a form that \p{C} minus \p{Cs}
+ * @param a
+ */
+export const isVaildText = (a: string) => {
+  // If the regex matches, the string is invalid.
+  return !XRegExp("\\p{Cc}|\\p{Cf}|\\p{Co}|\\p{Cn}|\\p{Zl}|\\p{Zp}", "A").test(
+    a
+  );
+};

src/s3.ts

@@ -3,6 +3,7 @@ import { Readable } from "stream";
 
 import { Vault } from "obsidian";
 
+import { Upload } from "@aws-sdk/lib-storage";
 import {
   S3Client,
   ListObjectsV2Command,
@@ -10,6 +11,9 @@ import {
   GetObjectCommand,
   DeleteObjectCommand,
   HeadObjectCommand,
+  HeadBucketCommand,
+  ListObjectsV2CommandInput,
+  ListObjectsV2CommandOutput,
 } from "@aws-sdk/client-s3";
 
 import type { _Object } from "@aws-sdk/client-s3";
@@ -95,7 +99,7 @@ export const uploadToRemote = async (
         ContentType: contentType,
       })
     );
-    return await getRemoteMeta(s3Client, s3Config, fileOrFolderPath);
+    return await getRemoteMeta(s3Client, s3Config, uploadFile);
   } else {
     // file
     // we ignore isRecursively parameter here
@@ -112,14 +116,24 @@ export const uploadToRemote = async (
       remoteContent = await encryptArrayBuffer(localContent, password);
     }
     const body = arrayBufferToBuffer(remoteContent);
-    await s3Client.send(
+
-      new PutObjectCommand({
+    const upload = new Upload({
+      client: s3Client,
+      queueSize: 20, // concurrency
+      partSize: 5242880, // minimal 5MB by default
+      leavePartsOnError: false,
+      params: {
         Bucket: s3Config.s3BucketName,
         Key: uploadFile,
         Body: body,
         ContentType: contentType,
-      })
+      },
-    );
+    });
+    upload.on("httpUploadProgress", (progress) => {
+      // console.log(progress);
+    });
+    await upload.done();
+
     return await getRemoteMeta(s3Client, s3Config, uploadFile);
   }
 };
@@ -129,17 +143,45 @@ export const listFromRemote = async (
   s3Config: S3Config,
   prefix?: string
 ) => {
+  const confCmd = {
+    Bucket: s3Config.s3BucketName,
+  } as ListObjectsV2CommandInput;
   if (prefix !== undefined) {
-    return await s3Client.send(
+    confCmd.Prefix = prefix;
-      new ListObjectsV2Command({
-        Bucket: s3Config.s3BucketName,
-        Prefix: prefix,
-      })
-    );
   }
-  return await s3Client.send(
+
-    new ListObjectsV2Command({ Bucket: s3Config.s3BucketName })
+  const contents = [] as _Object[];
-  );
+
+  let isTruncated = true;
+  let continuationToken = "";
+  do {
+    const rsp = await s3Client.send(new ListObjectsV2Command(confCmd));
+
+    if (rsp.$metadata.httpStatusCode !== 200) {
+      throw Error("some thing bad while listing remote!");
+    }
+    if (rsp.Contents === undefined) {
+      break;
+    }
+    contents.push(...rsp.Contents);
+
+    isTruncated = rsp.IsTruncated;
+    confCmd.ContinuationToken = rsp.NextContinuationToken;
+    if (
+      isTruncated &&
+      (continuationToken === undefined || continuationToken === "")
+    ) {
+      throw Error("isTruncated is true but no continuationToken provided");
+    }
+  } while (isTruncated);
+
+  // ensemble fake rsp
+  return {
+    "$.metadata": {
+      httpStatusCode: 200,
+    },
+    Contents: contents,
+  };
 };
 
 /**
@@ -266,3 +308,31 @@ export const deleteFromRemote = async (
     // pass
   }
 };
+
+/**
+ * Check the config of S3 by heading bucket
+ * https://stackoverflow.com/questions/50842835
+ * @param s3Client
+ * @param s3Config
+ * @returns
+ */
+export const checkS3Connectivity = async (
+  s3Client: S3Client,
+  s3Config: S3Config
+) => {
+  try {
+    const results = await s3Client.send(
+      new HeadBucketCommand({ Bucket: s3Config.s3BucketName })
+    );
+    if (
+      results === undefined ||
+      results.$metadata === undefined ||
+      results.$metadata.httpStatusCode === undefined
+    ) {
+      return false;
+    }
+    return results.$metadata.httpStatusCode === 200;
+  } catch (err) {
+    return false;
+  }
+};

src/sync.ts

@@ -1,14 +1,14 @@
 import { TAbstractFile, TFolder, TFile, Vault } from "obsidian";
 
 import { S3Client } from "@aws-sdk/client-s3";
-import * as lf from "lovefield-ts/dist/es6/lf.js";
 
 import {
   clearDeleteRenameHistoryOfKey,
-  FileFolderHistoryRecord,
   upsertSyncMetaMappingDataS3,
   getSyncMetaMappingByRemoteKeyS3,
 } from "./localdb";
+import type { FileFolderHistoryRecord, InternalDBs } from "./localdb";
+
 import {
   S3Config,
   S3ObjectType,
@@ -16,14 +16,24 @@ import {
   deleteFromRemote,
   downloadFromRemote,
 } from "./s3";
-import { mkdirpInVault, SUPPORTED_SERVICES_TYPE, isHiddenPath } from "./misc";
+import {
-import { decryptBase32ToString, encryptStringToBase32 } from "./encrypt";
+  mkdirpInVault,
+  SUPPORTED_SERVICES_TYPE,
+  isHiddenPath,
+  isVaildText,
+} from "./misc";
+import {
+  decryptBase32ToString,
+  encryptStringToBase32,
+  MAGIC_ENCRYPTED_PREFIX_BASE32,
+} from "./encrypt";
 
 export type SyncStatusType =
   | "idle"
   | "preparing"
   | "getting_remote_meta"
   | "getting_local_meta"
+  | "checking_password"
   | "generating_plan"
   | "syncing"
   | "finish";
@@ -61,11 +71,82 @@ export interface SyncPlanType {
   mixedStates: Record<string, FileOrFolderMixedState>;
 }
 
+export interface PasswordCheckType {
+  ok: boolean;
+  reason:
+    | "ok"
+    | "empty_remote"
+    | "remote_encrypted_local_no_password"
+    | "password_matched"
+    | "password_not_matched"
+    | "invalid_text_after_decryption"
+    | "remote_not_encrypted_local_has_password"
+    | "no_password_both_sides";
+}
+
+export const isPasswordOk = async (
+  remote: S3ObjectType[],
+  password: string = ""
+) => {
+  if (remote === undefined || remote.length === 0) {
+    // remote empty
+    return {
+      ok: true,
+      reason: "empty_remote",
+    } as PasswordCheckType;
+  }
+  const santyCheckKey = remote[0].Key;
+  if (santyCheckKey.startsWith(MAGIC_ENCRYPTED_PREFIX_BASE32)) {
+    // this is encrypted!
+    // try to decrypt it using the provided password.
+    if (password === "") {
+      return {
+        ok: false,
+        reason: "remote_encrypted_local_no_password",
+      } as PasswordCheckType;
+    }
+    try {
+      const res = await decryptBase32ToString(santyCheckKey, password);
+
+      // additional test
+      // because iOS Safari bypasses decryption with wrong password!
+      if (isVaildText(res)) {
+        return {
+          ok: true,
+          reason: "password_matched",
+        } as PasswordCheckType;
+      } else {
+        return {
+          ok: false,
+          reason: "invalid_text_after_decryption",
+        } as PasswordCheckType;
+      }
+    } catch (error) {
+      return {
+        ok: false,
+        reason: "password_not_matched",
+      } as PasswordCheckType;
+    }
+  } else {
+    // it is not encrypted!
+    if (password !== "") {
+      return {
+        ok: false,
+        reason: "remote_not_encrypted_local_has_password",
+      } as PasswordCheckType;
+    }
+    return {
+      ok: true,
+      reason: "no_password_both_sides",
+    } as PasswordCheckType;
+  }
+};
+
 const ensembleMixedStates = async (
   remote: S3ObjectType[],
   local: TAbstractFile[],
   deleteHistory: FileFolderHistoryRecord[],
-  db: lf.DatabaseConnection,
+  db: InternalDBs,
   password: string = ""
 ) => {
   const results = {} as Record<string, FileOrFolderMixedState>;
@@ -86,12 +167,12 @@ const ensembleMixedStates = async (
 
       let r = {} as FileOrFolderMixedState;
       if (backwardMapping !== undefined) {
-        key = backwardMapping.local_key;
+        key = backwardMapping.localKey;
         r = {
           key: key,
           exist_remote: true,
-          mtime_remote: backwardMapping.local_mtime,
+          mtime_remote: backwardMapping.localMtime,
-          size_remote: backwardMapping.local_size,
+          size_remote: backwardMapping.localSize,
           remote_encrypted_key: remoteEncryptedKey,
         };
       } else {
@@ -159,11 +240,11 @@ const ensembleMixedStates = async (
 
   for (const entry of deleteHistory) {
     let key = entry.key;
-    if (entry.key_type === "folder") {
+    if (entry.keyType === "folder") {
       if (!entry.key.endsWith("/")) {
         key = `${entry.key}/`;
       }
-    } else if (entry.key_type === "file") {
+    } else if (entry.keyType === "file") {
       // pass
     } else {
       throw Error(`unexpected ${entry}`);
@@ -171,7 +252,7 @@ const ensembleMixedStates = async (
 
     const r = {
       key: key,
-      delete_time_local: entry.action_when,
+      delete_time_local: entry.actionWhen,
     } as FileOrFolderMixedState;
 
     if (isHiddenPath(key)) {
@@ -324,7 +405,7 @@ export const getSyncPlan = async (
   remote: S3ObjectType[],
   local: TAbstractFile[],
   deleteHistory: FileFolderHistoryRecord[],
-  db: lf.DatabaseConnection,
+  db: InternalDBs,
   password: string = ""
 ) => {
   const mixedStates = await ensembleMixedStates(
@@ -348,7 +429,7 @@ export const getSyncPlan = async (
 export const doActualSync = async (
   s3Client: S3Client,
   s3Config: S3Config,
-  db: lf.DatabaseConnection,
+  db: InternalDBs,
   vault: Vault,
   syncPlan: SyncPlanType,
   password: string = ""

styles.css

@@ -1 +1,5 @@
 /* set the styles */
+
+.password_second_confirm {
+  font-weight: bold;
+}

tests/encrypt.test.ts

@@ -1,6 +1,7 @@
 import * as fs from "fs";
 import * as path from "path";
-import { expect } from "chai";
+import * as chai from "chai";
+import chaiAsPromised from "chai-as-promised";
 import { base64ToBase32, bufferToArrayBuffer } from "../src/misc";
 import {
   decryptArrayBuffer,
@@ -9,6 +10,9 @@ import {
   encryptStringToBase32,
 } from "../src/encrypt";
 
+chai.use(chaiAsPromised);
+const expect = chai.expect;
+
 describe("Encryption tests", () => {
   beforeEach(function () {
     global.window = {
@@ -22,6 +26,14 @@ describe("Encryption tests", () => {
     expect(await encryptStringToBase32(k, password)).to.not.equal(k);
   });
 
+  it("should raise error using different password", async () => {
+    const k = "secret text";
+    const password = "hey";
+    const password2 = "hey2";
+    const enc = await encryptStringToBase32(k, password);
+    await expect(decryptBase32ToString(enc, password2)).to.be.rejected;
+  });
+
   it("should encrypt and decrypt string and get the same result returned", async () => {
     const k = "jfkkjkjbce7983ycdeknkkjckooAIUHIDIBIE((*BII)njD/d/dd/d/sjxhux";
     const password = "hfiuibec989###oiu982bj1`";

tests/misc.test.ts

@@ -70,3 +70,22 @@ describe("Misc: get folder levels", () => {
     expect(misc.getFolderLevels(item3)).to.deep.equal(res3);
   });
 });
+
+describe("Misc: vaild file name tests", () => {
+  it("should treat no ascii correctly", async () => {
+    const x = misc.isVaildText("😄🍎 apple 苹果");
+    // console.log(x)
+    expect(x).to.be.true;
+  });
+
+  it("should find not-printable chars correctly", async () => {
+    const x = misc.isVaildText("😄🍎 apple 苹果\u0000");
+    // console.log(x)
+    expect(x).to.be.false;
+  });
+
+  it("should allow spaces/slashes/...", async () => {
+    const x = misc.isVaildText("😄🍎 apple 苹果/-_=/\\*%^&@#$`");
+    expect(x).to.be.true;
+  });
+});

versions.json

@@ -1,3 +1,3 @@
 {
-  "0.0.10": "0.12.15"
+  "0.0.15": "0.12.15"
 }