0.2.2

.github/workflows/auto-build.yml

@@ -13,6 +13,8 @@ jobs:
   build:
     runs-on: ubuntu-latest
 
+    environment: env-for-buildci
+
     strategy:
       matrix:
         node-version: [16.x]

README.md

@@ -4,7 +4,7 @@ This is yet another unofficial sync plugin for Obsidian.
 
 ## Disclaimer
 
-- **This is NOT the [official sync service](https://github.com/fyears/obsidian-remotely-save.git) provided by Obsidian.**
+- **This is NOT the [official sync service](https://obsidian.md/sync) provided by Obsidian.**
 
 ## !!!Caution!!!
 
@@ -12,7 +12,10 @@ As of November 2021, the plugin is considered in BETA stage. **DO NOT USE IT for
 
 ## Features
 
-- **Amazon S3 or S3-compatible, and Dropbox services are supported.** Webdav supports on the half way.
+- Supports:
+  - Amazon S3 or S3-compatible
+  - Dropbox
+  - Webdav
 - **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).**
@@ -29,7 +32,7 @@ As of November 2021, the plugin is considered in BETA stage. **DO NOT USE IT for
 
 ## 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 #1: [![BuildCI](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml/badge.svg)](https://github.com/fyears/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.
 
@@ -49,12 +52,14 @@ As of November 2021, the plugin is considered in BETA stage. **DO NOT USE IT for
 
 - **This plugin's function for Dropbox is not as mature as functions for S3.**
 - **This plugin is NOT an official Dropbox product.** The plugin just uses Dropbox's public API.
-- After the authorization, the plugin can read your name and email (which cannot be unselected on Dropbox api), and read and write files in your Dropbox's `/Apps/obsidian-remotely-save` folder.
+- After the authorization, the plugin can read your name and email (which cannot be unselected on Dropbox api), and read and write files in your Dropbox's `/Apps/remotely-save` folder.
 - If you decide to authorize this plugin to connect to Dropbox, please go to plugin's settings, and choose Dropbox then follow the instructions.
 - Password-based end-to-end encryption is also supported.
 
 ### webdav
 
-- **webdav support is buggy (as of now, 20211122) and considered experimental, so it's hidden by default.** Highly recommend to use the more stable s3.
+- **webdav support is considered experimental.**
-- If you decide to give it a try, open settings, and click "Choose service" area five times, then a Notice should show up. Close and open settings again then you will be able to select webdav.
+- Currently only supports BASIC authorization method.
-- Currently webdav server should enable CORS for requests, because of technical limitations of mobile.
+- Currently webdav server has to be enabled CORS for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`, **AND** all webdav HTTP methods and webdav headers, because of technical limitations of mobile.
+  - Popular software NextCloud and OwnCloud do **NOT** enable CORS by default. If you are using any of them, you should find a way to enable CORS before using this plugin.
+  - The plugin is tested successfully under python package [`wsgidav` (version 4.0)](https://github.com/mar10/wsgidav). See [this issue](https://github.com/mar10/wsgidav/issues/239) for details.

esbuild.config.mjs

@@ -24,6 +24,7 @@ esbuild
       "obsidian",
       "electron",
       "fs",
+      "crypto",
       // ...builtins
     ],
     format: "cjs",

manifest.json

@@ -1,9 +1,9 @@
 {
-  "id": "obsidian-remotely-save",
+  "id": "remotely-save",
   "name": "Remotely Save",
-  "version": "0.1.9",
+  "version": "0.2.2",
   "minAppVersion": "0.12.15",
-  "description": "Yet another unofficial plugin allowing users to sync notes between local device and the cloud service.",
+  "description": "Yet another unofficial plugin allowing users to synchronize 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-remotely-save",
+  "name": "remotely-save",
-  "version": "0.1.9",
+  "version": "0.2.2",
   "description": "This is yet another sync plugin for Obsidian app.",
   "scripts": {
     "dev": "node esbuild.config.mjs",
@@ -13,10 +13,7 @@
   "browser": {
     "path": "path-browserify",
     "process": "process/browser",
-    "stream": "stream-browserify",
+    "stream": "stream-browserify"
-    "crypto": "crypto-browserify",
-    "util": "util/",
-    "assert": "assert/"
   },
   "source": "main.ts",
   "keywords": [],

src/main.ts

@@ -27,13 +27,16 @@ import type { InternalDBs } from "./localdb";
 import type { SyncStatusType, PasswordCheckType } from "./sync";
 import { isPasswordOk, getSyncPlan, doActualSync } from "./sync";
 
-import { S3Config, DEFAULT_S3_CONFIG } from "./s3";
+import { S3Config, DEFAULT_S3_CONFIG } from "./remoteForS3";
-import { WebdavConfig, DEFAULT_WEBDAV_CONFIG, WebdavAuthType } from "./webdav";
+import {
+  WebdavConfig,
+  DEFAULT_WEBDAV_CONFIG,
+  WebdavAuthType,
+} from "./remoteForWebdav";
 import {
   DropboxConfig,
   DEFAULT_DROPBOX_CONFIG,
-  getCodeVerifierAndChallenge,
+  getAuthUrlAndVerifier,
-  getAuthUrl,
   sendAuthReq,
   setConfigBySuccessfullAuthInplace,
 } from "./remoteForDropbox";
@@ -48,7 +51,6 @@ interface RemotelySavePluginSettings {
   dropbox: DropboxConfig;
   password: string;
   serviceType: SUPPORTED_SERVICES_TYPE;
-  enableExperimentService: boolean;
 }
 
 const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
@@ -57,7 +59,6 @@ const DEFAULT_SETTINGS: RemotelySavePluginSettings = {
   dropbox: DEFAULT_DROPBOX_CONFIG,
   password: "",
   serviceType: "s3",
-  enableExperimentService: false,
 };
 
 export default class RemotelySavePlugin extends Plugin {
@@ -67,7 +68,7 @@ export default class RemotelySavePlugin extends Plugin {
   syncStatus: SyncStatusType;
 
   async onload() {
-    console.log("loading plugin obsidian-remotely-save");
+    console.log("loading plugin remotely-save");
 
     await this.loadSettings();
 
@@ -191,7 +192,7 @@ export default class RemotelySavePlugin extends Plugin {
   }
 
   onunload() {
-    console.log("unloading plugin obsidian-remotely-save");
+    console.log("unloading plugin remotely-save");
     this.destroyDBs();
   }
 
@@ -296,13 +297,11 @@ export class DropboxAuthModal extends Modal {
     this.revokeAuthSetting = revokeAuthSetting;
   }
 
-  onOpen() {
+  async onOpen() {
     let { contentEl } = this;
 
-    const k = getCodeVerifierAndChallenge();
+    const { authUrl, verifier } = await getAuthUrlAndVerifier(
-    const authUrl = getAuthUrl(
+      this.plugin.settings.dropbox.clientID
-      this.plugin.settings.dropbox.clientID,
-      k.challenge
     );
 
     contentEl.createEl("p", {
@@ -336,7 +335,7 @@ export class DropboxAuthModal extends Modal {
           try {
             const authRes = await sendAuthReq(
               this.plugin.settings.dropbox.clientID,
-              k.verifier,
+              verifier,
               authCode
             );
             const self = this;
@@ -426,42 +425,9 @@ class RemotelySaveSettingTab extends PluginSettingTab {
     // we need to create the div in advance of any other service divs
     const serviceChooserDiv = generalDiv.createEl("div");
 
-    let clickChooserTimes = 0;
-    serviceChooserDiv.onClickEvent(async (x) => {
-      if (Platform.isIosApp) {
-        // downgrade the experiment
-        // because iOS doesn't support x.detail
-        clickChooserTimes += 1;
-        setTimeout(function () {
-          clickChooserTimes = 0;
-        }, 2000);
-      }
-
-      if ((Platform.isIosApp && clickChooserTimes === 5) || x.detail === 5) {
-        if (this.plugin.settings.serviceType === "webdav") {
-          new Notice(
-            "You've enabled hidden unstable experimental webdav support before. Nothing changes."
-          );
-        } else if (!this.plugin.settings.enableExperimentService) {
-          this.plugin.settings.enableExperimentService = true;
-          await this.plugin.saveSettings();
-          new Notice(
-            "You've enabled hidden unstable experimental webdav support. Reopen settings again and try webdav with caution."
-          );
-        } else if (this.plugin.settings.enableExperimentService) {
-          this.plugin.settings.enableExperimentService = false;
-          await this.plugin.saveSettings();
-          new Notice(
-            "You've disabled hidden unstable experimental webdav support. Reopen settings again."
-          );
-        }
-      }
-      x.preventDefault();
-    });
-
     const s3Div = containerEl.createEl("div", { cls: "s3-hide" });
     s3Div.toggleClass("s3-hide", this.plugin.settings.serviceType !== "s3");
-    s3Div.createEl("h2", { text: "S3 (-compatible) Service" });
+    s3Div.createEl("h2", { text: "Remote For S3 (-compatible)" });
 
     s3Div.createEl("p", {
       text: "You can use Amazon S3 or another S3-compatible service to sync your vault. Enter your bucket information below.",
@@ -588,7 +554,7 @@ class RemotelySaveSettingTab extends PluginSettingTab {
       "dropbox-hide",
       this.plugin.settings.serviceType !== "dropbox"
     );
-    dropboxDiv.createEl("h2", { text: "for Dropbox" });
+    dropboxDiv.createEl("h2", { text: "Remote For Dropbox" });
     dropboxDiv.createEl("p", {
       text: "Disclaimer: Sync support for Dropbox are more experimental, and s3 functions are more stable now.",
       cls: "dropbox-disclaimer",
@@ -602,7 +568,7 @@ class RemotelySaveSettingTab extends PluginSettingTab {
       cls: "dropbox-disclaimer",
     });
     dropboxDiv.createEl("p", {
-      text: "We will create a folder App/obsidian-remotely-save on your Dropbox. All files/folders sync would happen inside this folder.",
+      text: "We will create a folder Apps/remotely-save on your Dropbox. All files/folders sync would happen inside this folder.",
     });
 
     const dropboxSelectAuthDiv = dropboxDiv.createDiv();
@@ -709,7 +675,7 @@ class RemotelySaveSettingTab extends PluginSettingTab {
       this.plugin.settings.serviceType !== "webdav"
     );
 
-    webdavDiv.createEl("h2", { text: "Webdav Service" });
+    webdavDiv.createEl("h2", { text: "Remote For Webdav" });
 
     webdavDiv.createEl("p", {
       text: "Disclaimer: Webdav functions are more experimental, and s3 functions are more stable now.",
@@ -771,7 +737,7 @@ class RemotelySaveSettingTab extends PluginSettingTab {
       )
       .addDropdown((dropdown) => {
         dropdown.addOption("basic", "basic");
-        dropdown.addOption("digest", "digest");
+        // dropdown.addOption("digest", "digest");
 
         dropdown
           .setValue(this.plugin.settings.webdav.authType)
@@ -809,18 +775,10 @@ class RemotelySaveSettingTab extends PluginSettingTab {
       .setDesc("Choose a service, by default s3")
       .addDropdown(async (dropdown) => {
         const currService = this.plugin.settings.serviceType;
-        const enableExperimentService =
-          this.plugin.settings.enableExperimentService;
 
         dropdown.addOption("s3", "s3 (-compatible)");
         dropdown.addOption("dropbox", "Dropbox");
-        if (currService === "webdav" || enableExperimentService) {
         dropdown.addOption("webdav", "webdav (experimental)");
-          if (!enableExperimentService) {
-            this.plugin.settings.enableExperimentService = true;
-            await this.plugin.saveSettings();
-          }
-        }
         dropdown
           .setValue(this.plugin.settings.serviceType)
           .onChange(async (val: SUPPORTED_SERVICES_TYPE) => {

src/remote.ts

@@ -1,8 +1,8 @@
 import { Vault } from "obsidian";
 
 import type { SUPPORTED_SERVICES_TYPE } from "./baseTypes";
-import * as s3 from "./s3";
+import * as s3 from "./remoteForS3";
-import * as webdav from "./webdav";
+import * as webdav from "./remoteForWebdav";
 import * as dropbox from "./remoteForDropbox";
 
 export class RemoteClient {

src/remoteForDropbox.ts

@@ -1,9 +1,7 @@
 import * as path from "path";
 import { FileStats, Vault } from "obsidian";
-import { Buffer } from "buffer";
-import * as crypto from "crypto";
 
-import { Dropbox, DropboxResponse, files } from "dropbox";
+import { Dropbox, DropboxAuth, DropboxResponse, files } from "dropbox";
 export { Dropbox } from "dropbox";
 import { RemoteItem } from "./baseTypes";
 import {
@@ -162,32 +160,28 @@ const fixLastModifiedTimeInplace = (allFilesFolders: RemoteItem[]) => {
 // see https://dropbox.tech/developers/pkce--what-and-why-
 ////////////////////////////////////////////////////////////////////////////////
 
-const specialBase64Encode = (str: Buffer) => {
+export const getAuthUrlAndVerifier = async (appKey: string) => {
-  return str
+  const auth = new DropboxAuth({
-    .toString("base64")
+    clientId: appKey,
-    .replace(/\+/g, "-")
+  });
-    .replace(/\//g, "_")
+  const authUrl = (
-    .replace(/=/g, "");
+    await auth.getAuthenticationUrl(
-};
+      undefined,
-const sha256 = (buffer: string) => {
+      undefined,
-  return crypto.createHash("sha256").update(buffer).digest();
+      "code",
-};
+      "offline",
-
+      undefined,
-export const getCodeVerifierAndChallenge = () => {
+      "none",
-  const codeVerifier = specialBase64Encode(crypto.randomBytes(32));
+      true
-  // console.log(`Client generated code_verifier: ${codeVerifier}`);
+    )
-  const codeChallenge = specialBase64Encode(sha256(codeVerifier));
+  ).toString();
-  // console.log(`Client generated code_challenge: ${codeChallenge}`);
+  const verifier = auth.getCodeVerifier();
   return {
-    verifier: codeVerifier,
+    authUrl: authUrl,
-    challenge: codeChallenge,
+    verifier: verifier,
   };
 };
 
-export const getAuthUrl = (appKey: string, challenge: string) => {
-  return `https://www.dropbox.com/oauth2/authorize?client_id=${appKey}&response_type=code&code_challenge=${challenge}&code_challenge_method=S256&token_access_type=offline`;
-};
-
 export interface DropboxSuccessAuthRes {
   access_token: string;
   token_type: "bearer";
@@ -487,20 +481,41 @@ export const listFromRemote = async (
     throw Error("prefix not supported (yet)");
   }
   await client.init();
-  const res = await client.dropbox.filesListFolder({
+  let res = await client.dropbox.filesListFolder({
     path: `/${client.vaultName}`,
     recursive: true,
+    include_deleted: false,
+    limit: 1000,
   });
   if (res.status !== 200) {
     throw Error(JSON.stringify(res));
   }
   // console.log(res);
+
   const contents = res.result.entries;
   const unifiedContents = contents
     .filter((x) => x[".tag"] !== "deleted")
     .filter((x) => x.path_display !== `/${client.vaultName}`)
     .map((x) => fromDropboxItemToRemoteItem(x, client.vaultName));
+
+  while (res.result.has_more) {
+    res = await client.dropbox.filesListFolderContinue({
+      cursor: res.result.cursor,
+    });
+    if (res.status !== 200) {
+      throw Error(JSON.stringify(res));
+    }
+
+    const contents2 = res.result.entries;
+    const unifiedContents2 = contents2
+      .filter((x) => x[".tag"] !== "deleted")
+      .filter((x) => x.path_display !== `/${client.vaultName}`)
+      .map((x) => fromDropboxItemToRemoteItem(x, client.vaultName));
+    unifiedContents.push(...unifiedContents2);
+  }
+
   fixLastModifiedTimeInplace(unifiedContents);
+
   return {
     Contents: unifiedContents,
   };

src/remoteForWebdav.ts

@@ -226,7 +226,7 @@ export const deleteFromRemote = async (
   remoteFileName = getWebdavPath(remoteFileName);
   try {
     await client.deleteFile(remoteFileName);
-    console.log(`delete ${remoteFileName} succeeded`);
+    // console.log(`delete ${remoteFileName} succeeded`);
   } catch (err) {
     console.error("some error while deleting");
     console.log(err);

versions.json

@@ -1,3 +1,3 @@
 {
-  "0.1.9": "0.12.15"
+  "0.2.2": "0.12.15"
 }

webpack.config.js

@@ -1,7 +1,10 @@
+require("dotenv").config();
 const path = require("path");
 const webpack = require("webpack");
 const TerserPlugin = require("terser-webpack-plugin");
 
+const DEFAULT_DROPBOX_APP_KEY = process.env.DROPBOX_APP_KEY || "";
+
 module.exports = {
   entry: "./src/main.ts",
   target: "web",
@@ -11,6 +14,9 @@ module.exports = {
     libraryTarget: "commonjs",
   },
   plugins: [
+    new webpack.DefinePlugin({
+      "process.env.DEFAULT_DROPBOX_APP_KEY": `"${DEFAULT_DROPBOX_APP_KEY}"`,
+    }),
     // Work around for Buffer is undefined:
     // https://github.com/webpack/changelog-v5/issues/10
     new webpack.ProvidePlugin({
@@ -37,7 +43,8 @@ module.exports = {
       // buffer: require.resolve("buffer/"),
       // console: require.resolve("console-browserify"),
       // constants: require.resolve("constants-browserify"),
-      crypto: require.resolve("crypto-browserify"),
+      // crypto: require.resolve("crypto-browserify"),
+      crypto: false,
       // domain: require.resolve("domain-browser"),
       // events: require.resolve("events"),
       // http: require.resolve("stream-http"),