bump

- Now hidden files will not be synchronised while we are not configured.
  - Some processes could start without waiting for synchronisation to complete, but now they will wait for.
- Improved
  - Now, by placing `redflag3.md`, we can discard the local database and fetch again.

README.md

@@ -82,7 +82,9 @@ If you have deleted or renamed files, please wait until ⏳ icon disappeared.
 -   There are no 'exclude_folders' like configurations.
 -   While synchronizing, files are compared by their modification time and the older ones will be overwritten by the newer ones. Then plugin checks for conflicts and if a merge is needed, a dialog will open.
 -   Rarely, a file in the database could be corrupted. The plugin will not write to local storage when a file looks corrupted. If a local version of the file is on your device, the corruption could be fixed by editing the local file and synchronizing it. But if the file does not exist on any of your devices, then it can not be rescued. In this case, you can delete these items from the settings dialog.
--   To stop the boot-up sequence (eg. for fixing problems on databases), you can put a `redflag.md` file at the root of your vault.
+-   To stop the boot-up sequence (eg. for fixing problems on databases), you can put a `redflag.md` file (or directory) at the root of your vault.
+    Tip for iOS: a redflag directory can be created at the root of the vault using the File application.
+-   Also, with `redflag2.md` placed, we can automatically rebuild both the local and the remote databases during the boot-up sequence. With `redflag3.md`, we can discard only the local database and fetch from the remote again.
 -   Q: The database is growing, how can I shrink it down?
     A: each of the docs is saved with their past 100 revisions for detecting and resolving conflicts. Picturing that one device has been offline for a while, and comes online again. The device has to compare its notes with the remotely saved ones. If there exists a historic revision in which the note used to be identical, it could be updated safely (like git fast-forward). Even if that is not in revision histories, we only have to check the differences after the revision that both devices commonly have. This is like git's conflict-resolving method. So, We have to make the database again like an enlarged git repo if you want to solve the root of the problem.
 -   And more technical Information is in the [Technical Information](docs/tech_info.md)

manifest.json

@@ -1,7 +1,7 @@
 {
     "id": "obsidian-livesync",
     "name": "Self-hosted LiveSync",
-    "version": "0.17.21",
+    "version": "0.17.22",
     "minAppVersion": "0.9.12",
     "description": "Community implementation of self-hosted livesync. Reflect your vault changes to some other devices immediately. Please make sure to disable other synchronize solutions to avoid content corruption or duplication.",
     "author": "vorotamoroz",

package-lock.json

@@ -1,12 +1,12 @@
 {
     "name": "obsidian-livesync",
-    "version": "0.17.21",
+    "version": "0.17.22",
     "lockfileVersion": 2,
     "requires": true,
     "packages": {
         "": {
             "name": "obsidian-livesync",
-            "version": "0.17.21",
+            "version": "0.17.22",
             "license": "MIT",
             "dependencies": {
                 "diff-match-patch": "^1.0.5",

package.json

@@ -1,6 +1,6 @@
 {
     "name": "obsidian-livesync",
-    "version": "0.17.21",
+    "version": "0.17.22",
     "description": "Reflect your vault changes to some other devices immediately. Please make sure to disable other synchronize solutions to avoid content corruption or duplication.",
     "main": "main.js",
     "type": "module",

src/main.ts

@@ -1,6 +1,6 @@
 import { debounce, Notice, Plugin, TFile, addIcon, TFolder, normalizePath, TAbstractFile, Editor, MarkdownView, PluginManifest, App } from "obsidian";
 import { Diff, DIFF_DELETE, DIFF_EQUAL, DIFF_INSERT, diff_match_patch } from "diff-match-patch";
-import { EntryDoc, LoadedEntry, ObsidianLiveSyncSettings, diff_check_result, diff_result_leaf, EntryBody, LOG_LEVEL, VER, DEFAULT_SETTINGS, diff_result, FLAGMD_REDFLAG, SYNCINFO_ID, InternalFileEntry, SALT_OF_PASSPHRASE, ConfigPassphraseStore, CouchDBConnection, FLAGMD_REDFLAG2 } from "./lib/src/types";
+import { EntryDoc, LoadedEntry, ObsidianLiveSyncSettings, diff_check_result, diff_result_leaf, EntryBody, LOG_LEVEL, VER, DEFAULT_SETTINGS, diff_result, FLAGMD_REDFLAG, SYNCINFO_ID, InternalFileEntry, SALT_OF_PASSPHRASE, ConfigPassphraseStore, CouchDBConnection, FLAGMD_REDFLAG2, FLAGMD_REDFLAG3 } from "./lib/src/types";
 import { PluginDataEntry, PERIODIC_PLUGIN_SWEEP, PluginList, DevicePluginList, InternalFileInfo, queueItem, FileInfo } from "./types";
 import { delay, getDocData, isDocContentSame } from "./lib/src/utils";
 import { Logger } from "./lib/src/logger";
@@ -169,6 +169,19 @@ export default class ObsidianLiveSyncPlugin extends Plugin {
             await app.vault.delete(redflag, true);
         }
     }
+    isRedFlag3Raised(): boolean {
+        const redflag = getAbstractFileByPath(normalizePath(FLAGMD_REDFLAG3));
+        if (redflag != null) {
+            return true;
+        }
+        return false;
+    }
+    async deleteRedFlag3() {
+        const redflag = getAbstractFileByPath(normalizePath(FLAGMD_REDFLAG3));
+        if (redflag != null) {
+            await app.vault.delete(redflag, true);
+        }
+    }
 
     showHistory(file: TFile | string) {
         if (!this.settings.useHistory) {
@@ -376,7 +389,7 @@ export default class ObsidianLiveSyncPlugin extends Plugin {
             this.registerFileWatchEvents();
             if (this.localDatabase.isReady)
                 try {
-                    if (this.isRedFlagRaised() || this.isRedFlag2Raised()) {
+                    if (this.isRedFlagRaised() || this.isRedFlag2Raised() || this.isRedFlag3Raised()) {
                         this.settings.batchSave = false;
                         this.settings.liveSync = false;
                         this.settings.periodicReplication = false;
@@ -398,6 +411,26 @@ export default class ObsidianLiveSyncPlugin extends Plugin {
                             await this.markRemoteLocked();
                             await this.replicateAllToServer(true);
                             await this.deleteRedFlag2();
+                            if (await askYesNo(this.app, "Do you want to disable Suspend file watching and restart obsidian now?") == "yes") {
+                                this.settings.suspendFileWatching = false;
+                                await this.saveSettings();
+                                // @ts-ignore
+                                this.app.commands.executeCommandById("app:reload");
+                            }
+                        } else if (this.isRedFlag3Raised()) {
+                            Logger(`${FLAGMD_REDFLAG3} has been detected! Self-hosted LiveSync will discard the local database and fetch everything from the remote once again.`, LOG_LEVEL.NOTICE);
+                            await this.resetLocalDatabase();
+                            await this.markRemoteResolved();
+                            await this.openDatabase();
+                            this.isReady = true;
+                            await this.replicate(true);
+                            await this.deleteRedFlag3();
+                            if (await askYesNo(this.app, "Do you want to disable Suspend file watching and restart obsidian now?") == "yes") {
+                                this.settings.suspendFileWatching = false;
+                                await this.saveSettings();
+                                // @ts-ignore
+                                this.app.commands.executeCommandById("app:reload");
+                            }
                         } else {
                             await this.openDatabase();
                             const warningMessage = "The red flag is raised! The whole initialize steps are skipped, and any file changes are not captured.";
@@ -1632,6 +1665,19 @@ export default class ObsidianLiveSyncPlugin extends Plugin {
     async parseIncomingDoc(doc: PouchDB.Core.ExistingDocument<EntryBody>) {
         if (!this.isTargetFile(id2path(doc._id))) return;
         const skipOldFile = this.settings.skipOlderFilesOnSync && false; //patched temporary.
+        // Do not handle internal files if the feature has not been enabled.
+        if (isInternalMetadata(doc._id) && !this.settings.syncInternalFiles) return;
+        // It is better for your own safety, not to handle the following files
+        const ignoreFiles = [
+            "_design/replicate",
+            FLAGMD_REDFLAG,
+            FLAGMD_REDFLAG2,
+            FLAGMD_REDFLAG3
+        ];
+        if (!isInternalMetadata(doc._id) && ignoreFiles.contains(id2path(doc._id))) {
+            return;
+
+        }
         if ((!isInternalMetadata(doc._id)) && skipOldFile) {
             const info = getAbstractFileByPath(id2path(doc._id));
 
@@ -1911,7 +1957,7 @@ export default class ObsidianLiveSyncPlugin extends Plugin {
         if (this.settings.syncInternalFiles && this.settings.syncInternalFilesBeforeReplication && !this.settings.watchInternalFileChanges) {
             await this.syncInternalFilesAndDatabase("push", showMessage);
         }
-        this.localDatabase.openReplication(this.settings, false, showMessage, this.parseReplicationResult);
+        await this.localDatabase.openReplication(this.settings, false, showMessage, this.parseReplicationResult);
     }
 
     async initializeDatabase(showingNotice?: boolean) {

updates.md

@@ -10,63 +10,7 @@
     - Chunk ID numbering rules
 
 #### Minors
-- 0.17.1
-  - Fixed: Now we can verify and repair the database.
-  - Refactored inside.
-
-- 0.17.2
-  - New feature
-    - We can merge conflicted documents automatically if sensible.
-  - Fixed
-    - Writing to the storage will be pended while they have conflicts after replication.
-
-- 0.17.3
-  - Now we supported canvas! And conflicted JSON files are also synchronised with merging its content if they are obvious.
-
-- 0.17.4
-  - Canvases are now treated as a sort of plain text file. now we transfer only the metadata and chunks that have differences.
-
-- 0.17.5 Now `read chunks online` had been fixed, and a new feature: `Use dynamic iteration count` to reduce the load on encryption/decryption.
-  Note: `Use dynamic iteration count` is not compatible with earlier versions.
-- 0.17.6 Now our renamed/deleted files have been surely deleted again.
-- 0.17.7
-  - Fixed:
-    - Fixed merging issues.
-    - Fixed button styling.
-  - Changed:
-    - Conflict checking on synchronising has been enabled for every note in default.
-- 0.17.8
-  - Improved: Performance improved. Prebuilt PouchDB is no longer used.
-  - Fixed: Merging hidden files is also fixed.
-  - New Feature: Now we can synchronise automatically after merging conflicts.
-- 0.17.9
-  - Fixed: Conflict merge of internal files is no longer broken.
-  - Improved: Smoother status display inside the editor.
-- 0.17.10
-  - Fixed: Large file synchronising has been now addressed!
-  Note: When synchronising large files, we have to set `Chunk size` to lower than 50, disable `Read chunks online`, `Batch size` should be set 50-100, and `Batch limit` could be around 20.
-- 0.17.11
-  - Fixed:
-    - Performance improvement
-    - Now `Chunk size` can be set to under one hundred.
-  - New feature:
-    - The number of transfers required before replication stabilises is now displayed.
-- 0.17.12: Skipped.
-- 0.17.13
-  - Fixed: Document history is now displayed again.
-  - Reorganised: Many files have been refactored.
-- 0.17.14: Skipped.
-- 0.17.15
-  - Improved:
-    - Confidential information has no longer stored in data.json as is.
-    - Synchronising progress has been shown in the notification.
-    - We can commit passphrases with a keyboard.
-    - Configuration which had not been saved yet is marked now.
-    - Now the filename is shown on the Conflict resolving dialog
-  - Fixed:
-    - Hidden files have been synchronised again.
-    - Rename of files has been fixed again.
-  And, minor changes have been included.
+- __0.17.1 to 0.17.15 has been moved into `update_old.md`__
 
 - 0.17.16:
   - Improved:
@@ -96,5 +40,11 @@
       - We have been grateful to @karasevm!
     - The conflicted `data.json` is no longer merged automatically.
       - This behaviour is not configurable, unlike the `Use newer file if conflicted` of normal files.
+- 0.17.22
+  - Fixed:
+    - Now hidden files will not be synchronised while we are not configured.
+    - Some processes could start without waiting for synchronisation to complete, but now they will wait for.
+  - Improved
+    - Now, by placing `redflag3.md`, we can discard the local database and fetch again.
 
 ... To continue on to `updates_old.md`.

updates_old.md

@@ -1,3 +1,73 @@
+### 0.17.0
+- 0.17.0 has no surfaced changes but the design of saving chunks has been changed. They have compatibility but changing files after upgrading makes different chunks than before 0.16.x.
+  Please rebuild databases once if you have been worried about storage usage.
+
+  - Improved:
+    - Splitting markdown
+    - Saving chunks
+
+  - Changed:
+    - Chunk ID numbering rules
+
+#### Minors
+
+- 0.17.1
+  - Fixed: Now we can verify and repair the database.
+  - Refactored inside.
+
+- 0.17.2
+  - New feature
+    - We can merge conflicted documents automatically if sensible.
+  - Fixed
+    - Writing to the storage will be pended while they have conflicts after replication.
+
+- 0.17.3
+  - Now we supported canvas! And conflicted JSON files are also synchronised with merging its content if they are obvious.
+
+- 0.17.4
+  - Canvases are now treated as a sort of plain text file. now we transfer only the metadata and chunks that have differences.
+
+- 0.17.5 Now `read chunks online` had been fixed, and a new feature: `Use dynamic iteration count` to reduce the load on encryption/decryption.
+  Note: `Use dynamic iteration count` is not compatible with earlier versions.
+- 0.17.6 Now our renamed/deleted files have been surely deleted again.
+- 0.17.7
+  - Fixed:
+    - Fixed merging issues.
+    - Fixed button styling.
+  - Changed:
+    - Conflict checking on synchronising has been enabled for every note in default.
+- 0.17.8
+  - Improved: Performance improved. Prebuilt PouchDB is no longer used.
+  - Fixed: Merging hidden files is also fixed.
+  - New Feature: Now we can synchronise automatically after merging conflicts.
+- 0.17.9
+  - Fixed: Conflict merge of internal files is no longer broken.
+  - Improved: Smoother status display inside the editor.
+- 0.17.10
+  - Fixed: Large file synchronising has been now addressed!
+  Note: When synchronising large files, we have to set `Chunk size` to lower than 50, disable `Read chunks online`, `Batch size` should be set 50-100, and `Batch limit` could be around 20.
+- 0.17.11
+  - Fixed:
+    - Performance improvement
+    - Now `Chunk size` can be set to under one hundred.
+  - New feature:
+    - The number of transfers required before replication stabilises is now displayed.
+- 0.17.12: Skipped.
+- 0.17.13
+  - Fixed: Document history is now displayed again.
+  - Reorganised: Many files have been refactored.
+- 0.17.14: Skipped.
+- 0.17.15
+  - Improved:
+    - Confidential information has no longer stored in data.json as is.
+    - Synchronising progress has been shown in the notification.
+    - We can commit passphrases with a keyboard.
+    - Configuration which had not been saved yet is marked now.
+    - Now the filename is shown on the Conflict resolving dialog
+  - Fixed:
+    - Hidden files have been synchronised again.
+    - Rename of files has been fixed again.
+  And, minor changes have been included.
 
 ### 0.16.0
 - Now hidden files need not be scanned. Changes will be detected automatically.