0.1.3

.github/workflows/auto-build.yml

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

.gitignore

@@ -1,17 +1,20 @@
-# Intellij
-*.iml
-.idea
-
-# npm
-node_modules
-package-lock.json
-
-# build
-main.js
-*.js.map
-
-# obsidian
-data.json
-
-# hidden files
-.*
+# Intellij
+*.iml
+.idea
+
+# npm
+node_modules
+package-lock.json
+
+# build
+main.js
+*.js.map
+
+# obsidian
+data.json
+
+# debug
+logs.txt
+
+# hidden files
+.*

README.md

@@ -1,26 +1,44 @@
-# Save Remote
+# Remotely Save
 
-This is yet another sync plugin for Obsidian.
-
-## Download and Install
-
-[![BuildCI](https://github.com/fyears/obsidian-save-remote/actions/workflows/auto-build.yml/badge.svg)](https://github.com/fyears/obsidian-save-remote/actions/workflows/auto-build.yml)
-
-Every artifacts are placed in the "Summary" under every successful builds.
-
-Besides manually download the files, you can also use [Obsidian42 - BRAT](https://github.com/TfTHacker/obsidian42-brat) to install this plugin.
+This is yet another unofficial sync plugin for Obsidian.
 
 ## Disclaimer
 
-**This is NOT the official sync service provided by Obsidian.**
+- **This is NOT the [official sync service](https://github.com/fyears/obsidian-remotely-save.git) provided by Obsidian.**
 
 ## !!!Caution!!!
 
-As of October 2021, the plugin is under development. **DO NOT USE IT for any serious vaults.** Prepare for data loss!
+As of November 2021, the plugin is considered in BETA stage. **DO NOT USE IT for any serious vaults.** **Backup your vault before using this plugin.** Don't be surprise to data loss!
+
+## Features
+
+- **Amazon S3 or S3-compatible services are supported.** Webdav supports on the plan.
+- **Obsidiain Mobile supported.** Vaults can be synced across mobile and desktop devices with the cloud service as the "broker".
+- **[End-to-end encryption](./docs/encryption.md) supported.** Files would be encrypted using openssl format before being sent to the cloud **if** user specify a password.
+- **[Minimal Intrusive](./docs/minimal_intrusive_design.md).**
+- **Fully open source under [Apache-2.0 License](./LICENSE).**
+- **[Sync Algorithm open](./docs/sync_algorithm.md) for discussion.**
+
+## Limitations
+
+- **Users have to trigger the sync manually.** This design is intentional because the plugin is in beta, and it's better for users to be exactly aware of the running of this plugin.
+- **"deletion" operation can only be triggered from local device.** It's because of the "[minimal intrusive design](./docs/minimal_intrusive_design.md)". May be changed in the future.
+- **No Conflict resolution. No content-diff-and-patch algorithm.** All files and folders are compared using their local and remote "last modified time" and those with later "last modified time" wins.
+- **Cloud services cost you money.** Always be aware of the costs and pricing.
+- **All files or folder starting with `.` (dot) or `_` (underscore) are treated as hidden files, and would NOT be synced.** It's useful if you have some files just staying locally. But this strategy also means that themes / other plugins / settings of this plugin would neither be synced.
+
+## Download and Install
+
+- Option #1: [![BuildCI](https://github.com/fyears/obsidian-remotely-save/actions/workflows/auto-build.yml/badge.svg)](https://github.com/fyears/obsidian-remotely-save/actions/workflows/auto-build.yml) Every artifacts are placed in the "Summary" under every successful builds.
+- Option #2: Besides manually downloading the files, you can also use [Obsidian42 - BRAT](https://github.com/TfTHacker/obsidian42-brat) to install this plugin.
+- Option #3: The pluin would be submitted to the official "community plugin list" in near future.
 
 ## Usage
 
-Remote service in support list:
-
-- [x] AWS S3
-- [ ] webdav
+- Prepare your S3 (-compatible) service information: [endpoint, region](https://docs.aws.amazon.com/general/latest/gr/s3.html), [access key id, secret access key](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/getting-your-credentials.html), bucket name. The bucket should be empty and solely for syncing a vault.
+- Configure (enable) [CORS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html) for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`. It's unfortunately required, because the plugin sends requests from a browser-like envirement. And those addresses are tested and found on desktop and ios and android.
+- Download and enable this plugin.
+- Enter your infomation to the settings of this plugin.
+- If you want to enable end-to-end encryption, also set a password in settings. If you do not specify a password, the files and folders are synced in plain, original content to the cloud.
+- Click the new "switch" icon on the ribbon (the left sidebar), **every time** you want to sync your vault between local and remote. (No "auto sync" yet.)
+- **Be patient while syncing.** Especially in the first-time sync.

docs/algorithm.md

@@ -1,29 +0,0 @@
-# Algorithm
-
-## Sources
-
-We have three record sources:
-
-1. Local files
-2. Remote files
-3. Local "delete-or-rename" history.
-
-Assuming all sources are reliable.
-
-## Deal with them
-
-We list all combinations mutually exclusive and collectively exhaustive.
-
-| 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 |
-| 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) |
-| 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)) |
-| 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            |
-| 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            |
-| 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                                |

docs/encryption.md

@@ -0,0 +1,29 @@
+# Encryption
+
+If a password is set, the files are encrypted before being sent to the cloud.
+
+The encryption algorithm is delibrately designed to be aligned with openssl format.
+
+1. The encryption algorithm is implemented using web-crypto.
+2. The file content is encrypted using openssl format. Assuming a file named `sometext.txt`, a password `somepassword`, then the encryption is equivalent to the following command:
+
+   ```bash
+   # file content encryption (ignoring file path encryption)
+   openssl enc -p -aes-256-cbc -pbkdf2 -iter 20000 -pass pass:somepassword -in ./sometext.txt -out ./sometext.txt.enc
+
+   # file content decryption (ignoring file path decryption)
+   openssl enc -d -p -aes-256-cbc -pbkdf2 -iter 20000 -pass pass:somepassword -in ./sometext.txt.enc -out ./sometext.txt
+   ```
+
+3. The file/directory path strings, are encrypted using openssl in binary mode and then `base32` is applied.
+   Assuming the file path is `a-folder-文件夹/a-file-文件.md`, then the following commands are equivilent:
+
+   ```bash
+   # pure string encryption then base32
+   echo -n 'a-folder-文件夹/a-file-文件.md' | openssl enc -aes-256-cbc -pbkdf2 -iter 20000 -pass pass:mylongpassword | base32 -w 0
+
+   # pure string base32 then decryption
+   echo -n 'KNQWY5DFMRPV7UHRWVYFSHE2XVVVZCFN65SR7ETEKO5L6EYGXCVEPT4A2LVTW4W2ZHXWF3K22SVA562CCZ6SALARXJY6AAXXHLK5UOA=' | base32 -d -w 00 | openssl enc -d -aes-256-cbc -pbkdf2 -iter 20000 -pass pass:mylongpassword
+   ```
+
+4. The directory is considered as special "0-byte" object on remote s3. So this meta infomation may be easily guessed if some third party can access the remote bucket.

docs/minimal_intrusive_design.md

@@ -0,0 +1,36 @@
+# Minimal Intrusive Design
+
+The plugin tries to avoid saving additional meta data remotely.
+
+## Benefits
+
+Then the plugin doesn't make any assumptions about information on the remote endpoint.
+
+For example, it's possbile for a uses to manually upload a file to s3, and next time the plugin can download that file to the local device.
+
+And it's also possible to combine another "sync-to-s3" solution (like, another software) on desktops, and this plugin on mobile devices, together.
+
+## Flaws
+
+The main issue comes from deletions (and renamings which is actually interpreted as "deletion-then-creation").
+
+Consider this:
+
+1. The user create and sync a file to the cloud on the 1st device.
+2. Then download this file to the 2nd device.
+3. And then delete this file on the 1st device.
+4. And sync on the 1st device. The file on the cloud is also deleted.
+5. And sync on the 2nd device. **The 2nd device would upload the file again to the cloud.**
+
+In step 4, the file is marked "deleted" on the 1st device, and the 1st device send the command "delete this file on the cloud" to the cloud sevice (e.g. s3). Then the file on the cloud is also deleted. So far so good.
+
+But, in step 5, because no meta data are saved on the cloud, the 2nd device doesn't know that the file are deleted. Instead, it thinks "the file was not synced to the cloud last time, so it's uploaded this time". So an unintentional upload occurs.
+
+Currently no way to fix this if no meta data are saved remotely. The only workarounds are:
+
+1. Delete the file on the 1st device, **before** syncing it to the cloud. Then the file never show up on the cloud or on the 2nd device.
+2. Or, manually delete the file on 2nd device **before** step 5 in above situation.
+
+## Future
+
+This design may be changed in the feature, considering the flaws described above.

docs/sync_algorithm.md

@@ -0,0 +1,29 @@
+# Sync Algorithm
+
+## Sources
+
+We have three record sources:
+
+1. Local files
+2. Remote files
+3. Local "delete-or-rename" history.
+
+Assuming all sources are reliable.
+
+## Deal with them
+
+We list all combinations mutually exclusive and collectively exhaustive.
+
+| 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                   |
+| 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)                       |
+| 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)) |
+| 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                                                        |
+| 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                                                        |
+| 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                                                                            |

manifest.json

@@ -1,9 +1,9 @@
 {
-  "id": "obsdian-save-remote",
-  "name": "Save remote",
-  "version": "0.0.9",
+  "id": "obsidian-remotely-save",
+  "name": "Remotely Save",
+  "version": "0.1.3",
   "minAppVersion": "0.12.15",
-  "description": "This is yet another plugin allowing users to sync notes between local device and the cloud.",
+  "description": "Yet another unofficial plugin allowing users to sync notes between local device and the cloud service.",
   "author": "fyears",
   "authorUrl": "https://github.com/fyears",
   "isDesktopOnly": false

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "obsidian-save-remote",
-  "version": "0.0.9",
+  "name": "obsidian-remotely-save",
+  "version": "0.1.3",
   "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 {
-  insertSyncPlanRecord,
-  clearAllSyncPlanRecords,
-  readAllSyncPlanRecordTexts,
-} from "./localdb";
+import { readAllSyncPlanRecordTexts } from "./localdb";
+import type { InternalDBs } from "./localdb";
 import { mkdirpInVault } from "./misc";
 
-const DEFAULT_DEBUG_FOLDER = "_debug_save_remote/";
+const DEFAULT_DEBUG_FOLDER = "_debug_remotely_save/";
 const DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX = "sync_plans_hist_exported_on_";
 
-export const exportSyncPlansToFiles = async (
-  db: lf.DatabaseConnection,
-  vault: Vault
-) => {
+export const exportSyncPlansToFiles = async (db: InternalDBs, vault: Vault) => {
   console.log("exporting");
   await mkdirpInVault(DEFAULT_DEBUG_FOLDER, vault);
   const records = await readAllSyncPlanRecordTexts(db);

src/encrypt.ts

@@ -6,7 +6,10 @@ import {
   arrayBufferToHex,
 } from "./misc";
 
-const DEFAULT_ITER = 10000;
+const DEFAULT_ITER = 20000;
+
+// base32.stringify(Buffer.from('Salted__'))
+export const MAGIC_ENCRYPTED_PREFIX_BASE32 = "KNQWY5DFMRPV";
 
 const getKeyIVFromPassword = async (
   salt: Uint8Array,

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_NAME = "saveremotedb";
+export const DEFAULT_DB_VERSION_NUMBER: number = 20211114;
+export const DEFAULT_DB_NAME = "remotelysavedb";
+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;
-  action_type: "delete" | "rename";
-  key_type: "folder" | "file";
-  rename_to: string;
+  actionWhen: number;
+  actionType: "delete" | "rename";
+  keyType: "folder" | "file";
+  renameTo: string;
 }
 
-export interface SyncMetaMappingRecord {
-  local_key: string;
-  remote_key: string;
-  local_size: number;
-  remote_size: number;
-  local_mtime: number;
-  remote_mtime: number;
-  remote_extra_key: string;
-  remote_type: SUPPORTED_SERVICES_TYPE;
-  key_type: "folder" | "file";
+interface SyncMetaMappingRecord {
+  localKey: string;
+  remoteKey: string;
+  localSize: number;
+  remoteSize: number;
+  localMtime: number;
+  remoteMtime: number;
+  remoteExtraKey: string;
+  remoteType: SUPPORTED_SERVICES_TYPE;
+  keyType: "folder" | "file";
 }
 
 interface SyncPlanRecord {
   ts: number;
-  remote_type: string;
-  sync_plan: string;
+  remoteType: 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);
-  schemaBuilder
-    .createTable(DEFAULT_TBL_DELETE_HISTORY)
-    .addColumn("id", lf.Type.INTEGER)
-    .addColumn("key", lf.Type.STRING)
-    .addColumn("ctime", lf.Type.INTEGER)
-    .addColumn("mtime", lf.Type.INTEGER)
-    .addColumn("size", lf.Type.INTEGER)
-    .addColumn("action_when", lf.Type.INTEGER)
-    .addColumn("action_type", lf.Type.STRING)
-    .addColumn("key_type", lf.Type.STRING)
-    .addPrimaryKey(["id"], true)
-    .addIndex("idxKey", ["key"]);
+  const db = {
+    versionTbl: localforage.createInstance({
+      name: DEFAULT_DB_NAME,
+      storeName: DEFAULT_TBL_VERSION,
+    }),
+    deleteHistoryTbl: localforage.createInstance({
+      name: DEFAULT_DB_NAME,
+      storeName: DEFAULT_TBL_DELETE_HISTORY,
+    }),
+    syncMappingTbl: localforage.createInstance({
+      name: DEFAULT_DB_NAME,
+      storeName: DEFAULT_TBL_SYNC_MAPPING,
+    }),
+    syncPlansTbl: localforage.createInstance({
+      name: DEFAULT_DB_NAME,
+      storeName: DEFAULT_SYNC_PLANS_HISTORY,
+    }),
+  } as InternalDBs;
 
-  schemaBuilder
-    .createTable(DEFAULT_TBL_SYNC_MAPPING)
-    .addColumn("id", lf.Type.INTEGER)
-    .addColumn("local_key", lf.Type.STRING)
-    .addColumn("remote_key", lf.Type.STRING)
-    .addColumn("local_size", lf.Type.INTEGER)
-    .addColumn("remote_size", lf.Type.INTEGER)
-    .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"]);
+  const originalVersion = (await db.versionTbl.getItem("version")) as number;
+  if (originalVersion === null) {
+    await db.versionTbl.setItem("version", DEFAULT_DB_VERSION_NUMBER);
+  } else if (originalVersion === DEFAULT_DB_VERSION_NUMBER) {
+    // do nothing
+  } else {
+    await migrateDBs(db, originalVersion, DEFAULT_DB_VERSION_NUMBER);
+  }
 
-  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) => {
-  db.close();
+export const destroyDBs = async () => {
+  // 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 (
-  db: lf.DatabaseConnection
-) => {
-  const schema = db.getSchema().table(DEFAULT_TBL_DELETE_HISTORY);
-  const tbl = db.getSchema().table(DEFAULT_TBL_DELETE_HISTORY);
+const migrateDBs = async (db: InternalDBs, oldVer: number, newVer: number) => {
+  if (oldVer === newVer) {
+    return;
+  }
+  // not implemented
+  throw Error(`not supported internal db changes from ${oldVer} to ${newVer}`);
+};
 
-  const records = await db
-    .select()
-    .from(schema)
-    .orderBy(schema.col("action_when"), lf.Order.ASC)
-    .exec();
-
-  return records as FileFolderHistoryRecord[];
+export const loadDeleteRenameHistoryTable = async (db: InternalDBs) => {
+  const records = [] as FileFolderHistoryRecord[];
+  await db.deleteHistoryTbl.iterate((value, key, iterationNumber) => {
+    records.push(value as FileFolderHistoryRecord);
+  });
+  records.sort((a, b) => a.actionWhen - b.actionWhen); // ascending
+  return records;
 };
 
 export const clearDeleteRenameHistoryOfKey = async (
-  db: lf.DatabaseConnection,
+  db: InternalDBs,
   key: string
 ) => {
-  const schema = db.getSchema().table(DEFAULT_TBL_DELETE_HISTORY);
-  const tbl = db.getSchema().table(DEFAULT_TBL_DELETE_HISTORY);
-
-  await db.delete().from(tbl).where(tbl.col("key").eq(key)).exec();
+  await db.deleteHistoryTbl.removeItem(key);
 };
 
 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(),
-      action_type: "delete",
-      key_type: "file",
-      rename_to: "",
+      actionWhen: Date.now(),
+      actionType: "delete",
+      keyType: "file",
+      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(),
-      action_type: "delete",
-      key_type: "folder",
-      rename_to: "",
+      actionWhen: Date.now(),
+      actionType: "delete",
+      keyType: "folder",
+      renameTo: "",
     };
   }
-  const row = tbl.createRow(k);
-  await db.insertOrReplace().into(tbl).values([row]).exec();
+  await db.deleteHistoryTbl.setItem(k.key, k);
 };
 
 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(),
-      action_type: "rename",
-      key_type: "file",
-      rename_to: fileOrFolder.path,
+      actionWhen: Date.now(),
+      actionType: "rename",
+      keyType: "file",
+      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(),
-      action_type: "rename",
-      key_type: "folder",
-      rename_to: renameTo,
+      actionWhen: Date.now(),
+      actionType: "rename",
+      keyType: "folder",
+      renameTo: renameTo,
     };
   }
-  const row = tbl.createRow(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;
+  await db.deleteHistoryTbl.setItem(k.key, k);
 };
 
 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,
-    local_mtime: localMTime,
-    local_size: localSize,
-    remote_key: remoteKey,
-    remote_mtime: remoteMTime,
-    remote_size: remoteSize,
-    remote_extra_key: remoteExtraKey,
-    remote_type: "s3",
-    key_type: localKey.endsWith("/") ? "folder" : "file",
+    localKey: localKey,
+    localMtime: localMTime,
+    localSize: localSize,
+    remoteKey: remoteKey,
+    remoteMtime: remoteMTime,
+    remoteSize: remoteSize,
+    remoteExtraKey: remoteExtraKey,
+    remoteType: "s3",
+    keyType: localKey.endsWith("/") ? "folder" : "file",
   };
-  const row = schema.createRow(aggregratedInfo);
-  await db.insertOrReplace().into(schema).values([row]).exec();
+  await db.syncMappingTbl.setItem(remoteKey, aggregratedInfo);
 };
 
 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 tbl = db.getSchema().table(DEFAULT_TBL_SYNC_MAPPING);
-  const res = (await db
-    .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[];
+  const potentialItem = (await db.syncMappingTbl.getItem(
+    remoteKey
+  )) as SyncMetaMappingRecord;
 
-  if (res.length === 1) {
-    return res[0];
-  }
-
-  if (res.length === 0) {
+  if (potentialItem === null) {
+    // no result was found
     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 row = schema.createRow({
+  const record = {
     ts: syncPlan.ts,
-    remote_type: syncPlan.remoteType,
-    sync_plan: JSON.stringify(syncPlan, null, 2),
-  } as SyncPlanRecord);
-  await db.insertOrReplace().into(schema).values([row]).exec();
+    remoteType: syncPlan.remoteType,
+    syncPlan: JSON.stringify(syncPlan /* directly stringify */, null, 2),
+  } as SyncPlanRecord;
+  await db.syncPlansTbl.setItem(`${syncPlan.ts}`, record);
 };
 
-export const clearAllSyncPlanRecords = async (db: lf.DatabaseConnection) => {
-  const tbl = db.getSchema().table(DEFAULT_SYNC_PLANS_HISTORY);
-  await db.delete().from(tbl).exec();
+export const clearAllSyncPlanRecords = async (db: InternalDBs) => {
+  await db.syncPlansTbl.clear();
 };
 
-export const readAllSyncPlanRecordTexts = async (db: lf.DatabaseConnection) => {
-  const schema = db.getSchema().table(DEFAULT_SYNC_PLANS_HISTORY);
-
-  const records = (await db
-    .select()
-    .from(schema)
-    .orderBy(schema.col("ts"), lf.Order.DESC)
-    .exec()) as SyncPlanRecord[];
+export const readAllSyncPlanRecordTexts = async (db: InternalDBs) => {
+  const records = [] as SyncPlanRecord[];
+  await db.syncPlansTbl.iterate((value, key, iterationNumber) => {
+    records.push(value as SyncPlanRecord);
+  });
+  records.sort((a, b) => -(a.ts - b.ts)); // descending
 
   if (records === undefined) {
     return [] as string[];
   } else {
-    return records.map((x) => x.sync_plan);
+    return records.map((x) => x.syncPlan);
   }
 };

src/main.ts

@@ -11,40 +11,47 @@ 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 { getSyncPlan, doActualSync } from "./sync";
-import { DEFAULT_S3_CONFIG, getS3Client, listFromRemote, S3Config } from "./s3";
+import type { SyncStatusType, PasswordCheckType } from "./sync";
+import { isPasswordOk, getSyncPlan, doActualSync } from "./sync";
+import {
+  DEFAULT_S3_CONFIG,
+  getS3Client,
+  listFromRemote,
+  S3Config,
+  checkS3Connectivity,
+} from "./s3";
 import { exportSyncPlansToFiles } from "./debugMode";
 
-interface SaveRemotePluginSettings {
+interface RemotelySavePluginSettings {
   s3?: S3Config;
   password?: string;
 }
 
-const DEFAULT_SETTINGS: SaveRemotePluginSettings = {
+const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
   s3: DEFAULT_S3_CONFIG,
   password: "",
 };
 
-export default class SaveRemotePlugin extends Plugin {
-  settings: SaveRemotePluginSettings;
+export default class RemotelySavePlugin extends Plugin {
+  settings: RemotelySavePluginSettings;
   cm: CodeMirror.Editor;
-  db: DatabaseConnection;
+  db: InternalDBs;
   syncStatus: SyncStatusType;
 
   async onload() {
-    console.log("loading plugin obsidian-save-remote");
+    console.log("loading plugin obsidian-remotely-save");
 
     await this.loadSettings();
 
@@ -64,14 +71,17 @@ export default class SaveRemotePlugin extends Plugin {
       })
     );
 
-    this.addRibbonIcon("switch", "Save Remote", async () => {
+    this.addRibbonIcon("switch", "Remotely Save", async () => {
       if (this.syncStatus !== "idle") {
-        new Notice(`Save Remote already running in stage ${this.syncStatus}!`);
+        new Notice(
+          `Remotely Save already running in stage ${this.syncStatus}!`
+        );
         return;
       }
 
       try {
-        new Notice("1/6 Save Remote Sync Preparing");
+        //console.log(`huh ${this.settings.password}`)
+        new Notice("1/6 Remotely Save Sync Preparing");
         this.syncStatus = "preparing";
 
         new Notice("2/6 Starting to fetch remote meta data.");
@@ -87,7 +97,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 +123,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 Remotely Save Sync data exchanging!");
 
         this.syncStatus = "syncing";
         await doActualSync(
@@ -114,25 +135,25 @@ export default class SaveRemotePlugin extends Plugin {
           this.settings.password
         );
 
-        new Notice("6/6 Save Remote finish!");
+        new Notice("7/7 Remotely Save finish!");
         this.syncStatus = "finish";
         this.syncStatus = "idle";
       } catch (error) {
-        const msg = `Save Remote error while ${this.syncStatus}`;
+        const msg = `Remotely Save error while ${this.syncStatus}`;
         console.log(msg);
         console.log(error);
         new Notice(msg);
-        new Notice(error);
+        new Notice(error.message);
         this.syncStatus = "idle";
       }
     });
 
-    this.addSettingTab(new SaveRemoteSettingTab(this.app, this));
+    this.addSettingTab(new RemotelySaveSettingTab(this.app, this));
 
-    this.registerCodeMirror((cm: CodeMirror.Editor) => {
-      this.cm = cm;
-      console.log("codemirror registered.");
-    });
+    // this.registerCodeMirror((cm: CodeMirror.Editor) => {
+    //   this.cm = cm;
+    //   console.log("codemirror registered.");
+    // });
 
     // this.registerDomEvent(document, "click", (evt: MouseEvent) => {
     //   console.log("click", evt);
@@ -144,7 +165,7 @@ export default class SaveRemotePlugin extends Plugin {
   }
 
   onunload() {
-    console.log("unloading plugin obsidian-save-remote");
+    console.log("unloading plugin obsidian-remotely-save");
     this.destroyDBs();
   }
 
@@ -165,10 +186,68 @@ export default class SaveRemotePlugin extends Plugin {
   }
 }
 
-class SaveRemoteSettingTab extends PluginSettingTab {
-  plugin: SaveRemotePlugin;
+export class PasswordModal extends Modal {
+  plugin: RemotelySavePlugin;
+  newPassword: string;
+  constructor(app: App, plugin: RemotelySavePlugin, newPassword: string) {
+    super(app);
+    this.plugin = plugin;
+    this.newPassword = newPassword;
+  }
 
-  constructor(app: App, plugin: SaveRemotePlugin) {
+  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 RemotelySaveSettingTab extends PluginSettingTab {
+  plugin: RemotelySavePlugin;
+
+  constructor(app: App, plugin: RemotelySavePlugin) {
     super(app, plugin);
     this.plugin = plugin;
   }
@@ -178,11 +257,46 @@ class SaveRemoteSettingTab extends PluginSettingTab {
 
     containerEl.empty();
 
-    containerEl.createEl("h1", { text: "Save Remote" });
+    containerEl.createEl("h1", { text: "Remotely Save" });
 
-    containerEl.createEl("h2", { text: "S3" });
+    const s3Div = containerEl.createEl("div");
+    s3Div.createEl("h2", { text: "S3 (-compatible) Service" });
 
-    new Setting(containerEl)
+    s3Div.createEl("p", {
+      text: "You can use Amazon S3 or another S3-compatible service to sync your vault. Enter your bucket information below.",
+    });
+
+    s3Div.createEl("p", {
+      text: "Disclaimer: The infomation is stored in PLAIN TEXT locally. Other malicious/harmful/faulty plugins may or may not be able to read the info. If you see any unintentional access to your S3 bucket, please immediately delete the access key to stop further accessment.",
+      cls: "s3-disclaimer",
+    });
+
+    s3Div.createEl("p", {
+      text: "You need to configure CORS to allow requests from origin app://obsidian.md and capacitor://localhost and http://localhost",
+    });
+
+    s3Div.createEl("p", {
+      text: "Some Amazon S3 official docs:",
+    });
+
+    const s3LinksUl = s3Div.createEl("div").createEl("ul");
+
+    s3LinksUl.createEl("li").createEl("a", {
+      href: "https://docs.aws.amazon.com/general/latest/gr/s3.html",
+      text: "Endpoint and region info",
+    });
+
+    s3LinksUl.createEl("li").createEl("a", {
+      href: "https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/getting-your-credentials.html",
+      text: "Access key ID and Secret access key info",
+    });
+
+    s3LinksUl.createEl("li").createEl("a", {
+      href: "https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html",
+      text: "Configuring CORS",
+    });
+
+    new Setting(s3Div)
       .setName("s3Endpoint")
       .setDesc("s3Endpoint")
       .addText((text) =>
@@ -195,7 +309,7 @@ class SaveRemoteSettingTab extends PluginSettingTab {
           })
       );
 
-    new Setting(containerEl)
+    new Setting(s3Div)
       .setName("s3Region")
       .setDesc("s3Region")
       .addText((text) =>
@@ -208,7 +322,7 @@ class SaveRemoteSettingTab extends PluginSettingTab {
           })
       );
 
-    new Setting(containerEl)
+    new Setting(s3Div)
       .setName("s3AccessKeyID")
       .setDesc("s3AccessKeyID")
       .addText((text) =>
@@ -221,7 +335,7 @@ class SaveRemoteSettingTab extends PluginSettingTab {
           })
       );
 
-    new Setting(containerEl)
+    new Setting(s3Div)
       .setName("s3SecretAccessKey")
       .setDesc("s3SecretAccessKey")
       .addText((text) =>
@@ -234,7 +348,7 @@ class SaveRemoteSettingTab extends PluginSettingTab {
           })
       );
 
-    new Setting(containerEl)
+    new Setting(s3Div)
       .setName("s3BucketName")
       .setDesc("s3BucketName")
       .addText((text) =>
@@ -247,23 +361,59 @@ class SaveRemoteSettingTab extends PluginSettingTab {
           })
       );
 
-    containerEl.createEl("h2", { text: "General" });
-    new Setting(containerEl)
+    new Setting(s3Div)
+      .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.");
+          }
+        });
+      });
+
+    const generalDiv = containerEl.createEl("div");
+    generalDiv.createEl("h2", { text: "General" });
+
+    const passwordDiv = generalDiv.createEl("div");
+    let newPassword = `${this.plugin.settings.password}`;
+    new Setting(passwordDiv)
       .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();
-            await this.plugin.saveSettings();
+            newPassword = value.trim();
           })
-      );
+      )
+      .addButton(async (button) => {
+        button.setButtonText("Confirm");
+        button.onClick(async () => {
+          new PasswordModal(this.app, this.plugin, newPassword).open();
+        });
+      });
 
-    containerEl.createEl("h2", { text: "Debug" });
+    const debugDiv = containerEl.createEl("div");
+    debugDiv.createEl("h2", { text: "Debug" });
+    const syncPlanDiv = debugDiv.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(containerEl)
+    new Setting(syncPlanDiv)
       .setName("export sync plans")
       .setDesc("export sync plans")
       .addButton(async (button) => {
@@ -274,7 +424,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 +434,38 @@ class SaveRemoteSettingTab extends PluginSettingTab {
           new Notice("sync plans history (in db) deleted");
         });
       });
+
+    const syncMappingDiv = debugDiv.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 = debugDiv.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";
@@ -41,9 +45,13 @@ export const DEFAULT_S3_CONFIG = {
 export type S3ObjectType = _Object;
 
 export const getS3Client = (s3Config: S3Config) => {
+  let endpoint = s3Config.s3Endpoint;
+  if (!(endpoint.startsWith("http://") || endpoint.startsWith("https://"))) {
+    endpoint = `https://${endpoint}`;
+  }
   const s3Client = new S3Client({
     region: s3Config.s3Region,
-    endpoint: s3Config.s3Endpoint,
+    endpoint: endpoint,
     credentials: {
       accessKeyId: s3Config.s3AccessKeyID,
       secretAccessKey: s3Config.s3SecretAccessKey,
@@ -95,7 +103,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 +120,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 +147,45 @@ export const listFromRemote = async (
   s3Config: S3Config,
   prefix?: string
 ) => {
+  const confCmd = {
+    Bucket: s3Config.s3BucketName,
+  } as ListObjectsV2CommandInput;
   if (prefix !== undefined) {
-    return await s3Client.send(
-      new ListObjectsV2Command({
-        Bucket: s3Config.s3BucketName,
-        Prefix: prefix,
-      })
-    );
+    confCmd.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 +312,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 { decryptBase32ToString, encryptStringToBase32 } from "./encrypt";
+import {
+  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,
-          size_remote: backwardMapping.local_size,
+          mtime_remote: backwardMapping.localMtime,
+          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(
@@ -335,7 +416,7 @@ export const getSyncPlan = async (
     password
   );
   for (const [key, val] of Object.entries(mixedStates)) {
-    getOperation(val, true);
+    getOperation(val, true, password);
   }
   const plan = {
     ts: Date.now(),
@@ -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,9 @@
 /* set the styles */
+
+.password_second_confirm {
+  font-weight: bold;
+}
+
+.s3-disclaimer {
+  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`";
@@ -48,10 +60,10 @@ describe("Encryption tests", () => {
     );
 
     // two command returns same result:
-    // cat ./sometext.txt | openssl enc -p -aes-256-cbc -S 8302F586FAB491EC -pbkdf2 -iter 10000 -base64 -pass pass:somepassword
-    // openssl enc -p -aes-256-cbc -S 8302F586FAB491EC -pbkdf2 -iter 10000 -base64 -pass pass:somepassword -in ./sometext.txt
+    // cat ./sometext.txt | openssl enc -p -aes-256-cbc -S 8302F586FAB491EC -pbkdf2 -iter 20000 -base64 -pass pass:somepassword
+    // openssl enc -p -aes-256-cbc -S 8302F586FAB491EC -pbkdf2 -iter 20000 -base64 -pass pass:somepassword -in ./sometext.txt
     const opensslBase64Res =
-      "U2FsdGVkX1+DAvWG+rSR7MSa+yJav1zCE7SSXiBooqwI5Q+LMpIthpk/pXkLj+25";
+      "U2FsdGVkX1+DAvWG+rSR7BPXMnlvSSVGMdjsx7kE1CTH+28P+yAZRdDGgFWMGkMd";
     // we output base32, so we need some transformation
     const opensslBase32Res = base64ToBase32(opensslBase64Res);
 
@@ -77,6 +89,8 @@ describe("Encryption tests", () => {
       await fs.readFileSync(path.join(testFolder, testFileName + ".enc"))
     );
 
+    // openssl enc -p -aes-256-cbc -S 8302F586FAB491EC -pbkdf2 -iter 20000 -pass pass:somepassword -in mona_lisa/1374px-Mona_Lisa,_by_Leonardo_da_Vinci,_from_C2RMF_retouched.jpg -out mona_lisa/1374px-Mona_Lisa,_by_Leonardo_da_Vinci,_from_C2RMF_retouched.jpg.enc
+
     expect(Buffer.from(enc).equals(Buffer.from(opensslArrBuf))).to.be.true;
   });
 

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;
+  });
+});

tests/static_assets/mona_lisa/1374px-Mona_Lisa,_by_Leonardo_da_Vinci,_from_C2RMF_retouched.jpg.enc

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:cf67abd791f1e230bce57dd47150f262424247cbefb8be16efcd57d13955576a
+oid sha256:7687eaf60ed93f754b107dc86a437aa97fad7bedd40432171b08c22cded7b559
 size 1141568

versions.json

@@ -1,3 +1,3 @@
 {
-  "0.0.9": "0.12.15"
+  "0.1.3": "0.12.15"
 }