bump to 0.3.13

README.md

@@ -61,8 +61,8 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 
 - 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.
 - About CORS:
-  - If you are using Obsidian >= 0.13.25, you can skip this CORS part.
-  - If you are using Obsidian < 0.13.25, you need to 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`, and add at least `ETag` into exposed headers. Full example is [here](./docs/s3_cors_configure.md). 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.
+  - If you are using Obsidian desktop >= 0.13.25 or mobile >= 1.1.1, you can skip this CORS part.
+  - If you are using Obsidian desktop < 0.13.25 or mobile < 1.1.1, you need to 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`, and add at least `ETag` into exposed headers. Full example is [here](./docs/s3_cors_configure.md). 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 information 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.
@@ -87,8 +87,8 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 ### webdav
 
 - About CORS:
-  - If you are using Obsidian >= 0.13.25, you can skip this CORS part.
-  - If you are using Obsidian < 0.13.25:
+  - If you are using Obsidian desktop >= 0.13.25 or mobile >= 1.1.1, you can skip this CORS part.
+  - If you are using Obsidian desktop < 0.13.25 or mobile < 1.1.1:
     - The 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** all webdav headers. These are required, because Obsidian mobile works like a browser and mobile plugins are limited by CORS policies unless under a upgraded Obsidian version.
     - Popular software NextCloud, OwnCloud, `rclone serve webdav` do **NOT** enable CORS by default. If you are using any of them, you should evaluate the risk, and find a way to enable CORS, before using this plugin, or use a upgraded Obsidian version.
     - 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 some details.

docs/browser_env_cors.md

@@ -4,6 +4,6 @@ The plugin is developed for the browser environment. The "fake" browser behind t
 
 [MDN has a doc about CORS.](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)
 
-From Obsidian version >= insider 0.13.25, Obsidian [provides a new API `requiestUrl`](https://forum.obsidian.md/t/obsidian-release-v0-13-25-insider-build/32701), that allows the plugin to fully bypass the CORS issue. As of Mar 2022, the latest public-released Obsidian desktop has supported this API, but the Obsidian mobile still stays in insider.
+From Obsidian desktop >= 0.13.25 or mobile >= 1.1.1, Obsidian [provides a new API `requiestUrl`](https://forum.obsidian.md/t/obsidian-release-v0-13-25-insider-build/32701), that allows the plugin to fully bypass the CORS issue. As of Mar 2022, the latest public-released Obsidian desktop has supported this API, but the Obsidian mobile still stays in insider.
 
-For using this plugin in Obsidian version < 0.13.25, we need to configure the server side to return the header `Access-Control-Allow-Origin` allowing the origins `app://obsidian.md` and `capacitor://localhost` and `http://localhost`. Here is an example [configuration for Amazon S3](./s3_cors_configure.md).
+For using this plugin in Obsidian desktop < 0.13.25 or mobile < 1.1.1, we need to configure the server side to return the header `Access-Control-Allow-Origin` allowing the origins `app://obsidian.md` and `capacitor://localhost` and `http://localhost`. Here is an example [configuration for Amazon S3](./s3_cors_configure.md).

docs/s3_cors_configure.md

@@ -1,6 +1,6 @@
 # How To Configure S3 CORS Rules
 
-If you are using the latest version of this plugin AND Obsidian >= 0.13.25, you do not need to configure it any more. If you are using Obsidian < 0.13.25, you are required to configure the rules as following.
+If you are using the latest version of this plugin AND Obsidian desktop >= 0.13.25, mobile >= 1.1.1, you do not need to configure it any more. If you are using Obsidian desktop < 0.13.25, moble < 1.1.1, you are required to configure the rules as following.
 
 Thanks to [@NAL100 in the Discussion](https://github.com/fyears/remotely-save/discussions/28).
 

docs/services_connectable_or_not.md

@@ -2,12 +2,12 @@
 
 Here is an overview of the connectability ("connectable" or "not connectable" or "in the plan" or "never") to some services by this plugin.
 
-The plugin works under the browser environment in Obsidian, so CORS is an issue. Obsidian starts to provide a rich API `requestUrl` for version >= 0.13.25 to bypass the CORS issue. But if the users are still using an older version of Obsidian, they need to configure CORS on server.
+The plugin works under the browser environment in Obsidian, so CORS is an issue. Obsidian starts to provide a rich API `requestUrl` for desktop version >= 0.13.25, mobile >= 1.1.1 to bypass the CORS issue. But if the users are still using an older version of Obsidian, they need to configure CORS on server.
 
 The list is for information purposes only.
 
-| Service                                                                               | Connectable | by S3 | by WebDAV | by other protocol                                                | can bypass CORS issue in Obsidian>=0.13.25 | need CORS config in Obsidian<0.13.25             |
-| ------------------------------------------------------------------------------------- | ----------- | ----- | --------- | ---------------------------------------------------------------- | ------------------------------------------ | ------------------------------------------------ |
+| Service                                                                               | Connectable | by S3 | by WebDAV | by other protocol                                                | can bypass CORS issue in latest Obsidian | need CORS config in old Obsidian                 |
+| ------------------------------------------------------------------------------------- | ----------- | ----- | --------- | ---------------------------------------------------------------- | ---------------------------------------- | ------------------------------------------------ |
 | Amazon S3                                                                             | Yes         | Yes   |           |                                                                  | Yes                                      | [CORS config needed.](./s3_cors_configure.md)    |
 | Tencent Cloud - Cloud Object Storage (COS) 腾讯云对象存储                             | Yes         | Yes   |           |                                                                  | Yes                                      | CORS config needed.                              |
 | Alibaba Cloud - Object Storage Service 阿里云对象存储                                 | Yes         | Yes   |           |                                                                  | Yes                                      | CORS config needed.                              |

manifest.json

@@ -1,7 +1,7 @@
 {
   "id": "remotely-save",
   "name": "Remotely Save",
-  "version": "0.3.9",
+  "version": "0.3.13",
   "minAppVersion": "0.13.21",
   "description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
   "author": "fyears",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "remotely-save",
-  "version": "0.3.9",
+  "version": "0.3.13",
   "description": "This is yet another sync plugin for Obsidian app.",
   "scripts": {
     "dev2": "node esbuild.config.mjs",

src/main.ts

@@ -101,11 +101,11 @@ export default class RemotelySavePlugin extends Plugin {
       return this.i18n.t(x, vars);
     };
 
-    const getNotice = (x: string) => {
+    const getNotice = (x: string, timeout?: number) => {
       // only show notices in manual mode
       // no notice in auto mode
       if (triggerSource === "manual" || triggerSource === "dry") {
-        new Notice(x);
+        new Notice(x, timeout);
       }
     };
     if (this.syncStatus !== "idle") {
@@ -331,8 +331,8 @@ export default class RemotelySavePlugin extends Plugin {
       });
       log.info(msg);
       log.info(error);
-      getNotice(msg);
-      getNotice(error.message);
+      getNotice(msg, 10 * 1000);
+      getNotice(error.message, 10 * 1000);
       this.syncStatus = "idle";
       if (this.syncRibbon !== undefined) {
         setIcon(this.syncRibbon, iconNameSyncWait);

src/remote.ts

@@ -271,15 +271,22 @@ export class RemoteClient {
     }
   };
 
-  checkConnectivity = async () => {
+  checkConnectivity = async (callbackFunc?: any) => {
     if (this.serviceType === "s3") {
-      return await s3.checkConnectivity(this.s3Client, this.s3Config);
+      return await s3.checkConnectivity(
+        this.s3Client,
+        this.s3Config,
+        callbackFunc
+      );
     } else if (this.serviceType === "webdav") {
-      return await webdav.checkConnectivity(this.webdavClient);
+      return await webdav.checkConnectivity(this.webdavClient, callbackFunc);
     } else if (this.serviceType === "dropbox") {
-      return await dropbox.checkConnectivity(this.dropboxClient);
+      return await dropbox.checkConnectivity(this.dropboxClient, callbackFunc);
     } else if (this.serviceType === "onedrive") {
-      return await onedrive.checkConnectivity(this.onedriveClient);
+      return await onedrive.checkConnectivity(
+        this.onedriveClient,
+        callbackFunc
+      );
     } else {
       throw Error(`not supported service type ${this.serviceType}`);
     }

src/remoteForDropbox.ts

@@ -636,7 +636,10 @@ export const deleteFromRemote = async (
   }
 };
 
-export const checkConnectivity = async (client: WrappedDropboxClient) => {
+export const checkConnectivity = async (
+  client: WrappedDropboxClient,
+  callbackFunc?: any
+) => {
   try {
     const results = await getRemoteMeta(client, "/");
     if (results === undefined) {
@@ -644,8 +647,10 @@ export const checkConnectivity = async (client: WrappedDropboxClient) => {
     }
     return true;
   } catch (err) {
-    console.error("dropbox connectivity error:");
-    console.error(err);
+    log.debug(err);
+    if (callbackFunc !== undefined) {
+      callbackFunc(err);
+    }
     return false;
   }
 };

src/remoteForOnedrive.ts

@@ -866,11 +866,18 @@ export const deleteFromRemote = async (
   await client.deleteJson(remoteFileName);
 };
 
-export const checkConnectivity = async (client: WrappedOnedriveClient) => {
+export const checkConnectivity = async (
+  client: WrappedOnedriveClient,
+  callbackFunc?: any
+) => {
   try {
     const k = await getUserDisplayName(client);
     return k !== "<unknown display name>";
   } catch (err) {
+    log.debug(err);
+    if (callbackFunc !== undefined) {
+      callbackFunc(err);
+    }
     return false;
   }
 };

src/remoteForS3.ts

@@ -498,7 +498,8 @@ export const deleteFromRemote = async (
  */
 export const checkConnectivity = async (
   s3Client: S3Client,
-  s3Config: S3Config
+  s3Config: S3Config,
+  callbackFunc?: any
 ) => {
   try {
     const results = await s3Client.send(
@@ -509,10 +510,19 @@ export const checkConnectivity = async (
       results.$metadata === undefined ||
       results.$metadata.httpStatusCode === undefined
     ) {
+      const err = "results or $metadata or httStatusCode is undefined";
+      log.debug(err);
+      if (callbackFunc !== undefined) {
+        callbackFunc(err);
+      }
       return false;
     }
     return results.$metadata.httpStatusCode === 200;
   } catch (err) {
+    log.debug(err);
+    if (callbackFunc !== undefined) {
+      callbackFunc(err);
+    }
     return false;
   }
 };

src/remoteForWebdav.ts

@@ -1,5 +1,11 @@
 import { Buffer } from "buffer";
-import { Vault, request, requestUrl, requireApiVersion } from "obsidian";
+import {
+  Vault,
+  request,
+  requestUrl,
+  requireApiVersion,
+  Platform,
+} from "obsidian";
 
 import { Queue } from "@fyears/tsqueue";
 import chunk from "lodash/chunk";
@@ -20,7 +26,7 @@ import type {
   ResponseDataDetailed,
 } from "webdav/web";
 import { getPatcher } from "webdav/web";
-if (requireApiVersion(API_VER_REQURL)) {
+if (requireApiVersion(API_VER_REQURL) && !Platform.isAndroidApp) {
   getPatcher().patch(
     "request",
     async (
@@ -110,6 +116,7 @@ if (requireApiVersion(API_VER_REQURL)) {
 //   return r;
 // });
 import { AuthType, BufferLike, createClient } from "webdav/web";
+import { Plane } from "lucide";
 export type { WebDAVClient } from "webdav/web";
 
 export const DEFAULT_WEBDAV_CONFIG = {
@@ -204,7 +211,7 @@ export class WrappedWebdavClient {
     if (this.vaultFolderExists) {
       // pass
     } else {
-      const res = await this.client.exists(`/${this.vaultName}`);
+      const res = await this.client.exists(`/${this.vaultName}/`);
       if (res) {
         // log.info("remote vault folder exits!");
         this.vaultFolderExists = true;
@@ -223,7 +230,7 @@ export class WrappedWebdavClient {
         const res = await this.client.customRequest(`/${this.vaultName}`, {
           method: "PROPFIND",
           headers: {
-            Depth: "Infinity",
+            Depth: "infinity",
           },
           responseType: "text",
         });
@@ -523,15 +530,40 @@ export const deleteFromRemote = async (
   }
 };
 
-export const checkConnectivity = async (client: WrappedWebdavClient) => {
+export const checkConnectivity = async (
+  client: WrappedWebdavClient,
+  callbackFunc?: any
+) => {
+  if (
+    !(
+      client.webdavConfig.address.startsWith("http://") ||
+      client.webdavConfig.address.startsWith("https://")
+    )
+  ) {
+    const err = "Error: the url should start with http(s):// but it does not!";
+    log.debug(err);
+    if (callbackFunc !== undefined) {
+      callbackFunc(err);
+    }
+    return false;
+  }
   try {
     await client.init();
     const results = await getRemoteMeta(client, "/");
     if (results === undefined) {
+      const err = "results is undefined";
+      log.debug(err);
+      if (callbackFunc !== undefined) {
+        callbackFunc(err);
+      }
       return false;
     }
     return true;
   } catch (err) {
+    log.debug(err);
+    if (callbackFunc !== undefined) {
+      callbackFunc(err);
+    }
     return false;
   }
 };

src/settings.ts

@@ -826,11 +826,15 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
         button.onClick(async () => {
           new Notice(t("settings_checkonnectivity_checking"));
           const client = new RemoteClient("s3", this.plugin.settings.s3);
-          const res = await client.checkConnectivity();
+          const errors = { msg: "" };
+          const res = await client.checkConnectivity((err: any) => {
+            errors.msg = err;
+          });
           if (res) {
             new Notice(t("settings_s3_connect_succ"));
           } else {
             new Notice(t("settings_s3_connect_fail"));
+            new Notice(errors.msg);
           }
         });
       });
@@ -959,11 +963,15 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
             () => self.plugin.saveSettings()
           );
 
-          const res = await client.checkConnectivity();
+          const errors = { msg: "" };
+          const res = await client.checkConnectivity((err: any) => {
+            errors.msg = `${err}`;
+          });
           if (res) {
             new Notice(t("settings_dropbox_connect_succ"));
           } else {
             new Notice(t("settings_dropbox_connect_fail"));
+            new Notice(errors.msg);
           }
         });
       });
@@ -1074,11 +1082,15 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
             () => self.plugin.saveSettings()
           );
 
-          const res = await client.checkConnectivity();
+          const errors = { msg: "" };
+          const res = await client.checkConnectivity((err: any) => {
+            errors.msg = `${err}`;
+          });
           if (res) {
             new Notice(t("settings_onedrive_connect_succ"));
           } else {
             new Notice(t("settings_onedrive_connect_fail"));
+            new Notice(errors.msg);
           }
         });
       });
@@ -1093,6 +1105,9 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
       this.plugin.settings.serviceType !== "webdav"
     );
 
+    const webdavReq =
+      requireApiVersion(API_VER_REQURL) && !Platform.isAndroidApp;
+
     webdavDiv.createEl("h2", { text: t("settings_webdav") });
 
     webdavDiv.createEl("p", {
@@ -1100,7 +1115,17 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
       cls: "webdav-disclaimer",
     });
 
-    if (!requireApiVersion(API_VER_REQURL)) {
+    if (!webdavReq) {
+      if (Platform.isAndroidApp) {
+        webdavDiv.createEl("p", {
+          text: t("settings_webdav_cors_android"),
+        });
+      } else {
+        webdavDiv.createEl("p", {
+          text: t("settings_webdav_cors_otheros"),
+        });
+      }
+
       webdavDiv.createEl("p", {
         text: t("settings_webdav_cors"),
       });
@@ -1156,15 +1181,12 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
       .setDesc(t("settings_webdav_auth_desc"))
       .addDropdown(async (dropdown) => {
         dropdown.addOption("basic", "basic");
-        if (requireApiVersion(API_VER_REQURL)) {
+        if (webdavReq) {
           dropdown.addOption("digest", "digest");
         }
 
         // new version config, copied to old version, we need to reset it
-        if (
-          !requireApiVersion(API_VER_REQURL) &&
-          this.plugin.settings.webdav.authType !== "basic"
-        ) {
+        if (!webdavReq && this.plugin.settings.webdav.authType !== "basic") {
           this.plugin.settings.webdav.authType = "basic";
           await this.plugin.saveSettings();
         }
@@ -1230,20 +1252,19 @@ export class RemotelySaveSettingTab extends PluginSettingTab {
             this.app.vault.getName(),
             () => self.plugin.saveSettings()
           );
-          const res = await client.checkConnectivity();
+          const errors = { msg: "" };
+          const res = await client.checkConnectivity((err: any) => {
+            errors.msg = `${err}`;
+          });
           if (res) {
             new Notice(t("settings_webdav_connect_succ"));
           } else {
-            let corsErrMsg = "/CORS";
-            if (requireApiVersion(API_VER_REQURL)) {
-              corsErrMsg = "";
+            if (webdavReq) {
+              new Notice(t("settings_webdav_connect_fail"));
+            } else {
+              new Notice(t("settings_webdav_connect_fail_withcors"));
             }
-
-            new Notice(
-              t("settings_webdav_connect_fail", {
-                corsErrMsg: corsErrMsg,
-              })
-            );
+            new Notice(errors.msg);
           }
         });
       });

src/sync.ts

@@ -323,7 +323,7 @@ const ensembleMixedStates = async (
       r = {
         key: entry.path,
         existLocal: true,
-        mtimeLocal: Math.max(entry.stat.mtime, entry.stat.ctime),
+        mtimeLocal: Math.max(entry.stat.mtime || 0, entry.stat.ctime || 0),
         sizeLocal: entry.stat.size,
       };
     } else if (entry instanceof TFolder) {
@@ -450,22 +450,30 @@ const assignOperationToFileInplace = (
   // 0. find anything inconsistent
   if (r.existLocal && (r.mtimeLocal === undefined || r.mtimeLocal <= 0)) {
     throw Error(
-      `Error: File ${r.key} has a last modified time <=0 or undefined in the local file system. It's abnormal and the plugin stops.`
+      `Error: Abnormal last modified time locally: ${JSON.stringify(
+        r,
+        null,
+        2
+      )}`
     );
   }
   if (r.existRemote && (r.mtimeRemote === undefined || r.mtimeRemote <= 0)) {
     throw Error(
-      `Error: File ${r.key} has a last modified time <=0 or undefined on the remote service. It's abnormal and the plugin stops.`
+      `Error: Abnormal last modified time remotely: ${JSON.stringify(
+        r,
+        null,
+        2
+      )}`
     );
   }
   if (r.deltimeLocal !== undefined && r.deltimeLocal <= 0) {
     throw Error(
-      `Error: File ${r.key} has a local deletion time <=0. It's abnormal and the plugin stops.`
+      `Error: Abnormal deletion time locally: ${JSON.stringify(r, null, 2)}`
     );
   }
   if (r.deltimeRemote !== undefined && r.deltimeRemote <= 0) {
     throw Error(
-      `Error: File ${r.key} has a remote deletion time <=0. It's abnormal and the plugin stops.`
+      `Error: Abnormal deletion time remotely: ${JSON.stringify(r, null, 2)}`
     );
   }
 

versions.json

@@ -1,4 +1,4 @@
 {
   "0.3.2": "0.12.15",
-  "0.3.9": "0.13.21"
+  "0.3.13": "0.13.21"
 }