Merge pull request #41 from tomasriveral/release/v2.2

[Automatic] Release PR v2.2

.github/workflows/release.yml

@@ -17,10 +17,6 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Install GitHub CLI
-        run: sudo apt-get update && sudo apt-get install -y gh
-
-
       - name: Configure git
         run: |
           git config user.name "github-actions[bot]"
@@ -30,7 +26,7 @@ jobs:
 
       - name: Create release branch
         run: |
-          git checkout -B release/v${{ inputs.version }}
+          git checkout -B release/${{ inputs.version }}
 
       - name: Set version in flake.nix
         run: |
@@ -46,14 +42,14 @@ jobs:
 
       - name: Push branch
         run: |
-          git push origin release/v${{ inputs.version }}
+          git push origin release/${{ inputs.version }}
 
       - name: Create Pull Request
         run: |
           gh pr create \
             --base main \
-            --head release/v${{ inputs.version }} \
-            --title "[Automatic] Release v${{ inputs.version }}" \
-            --body "Automated release PR.\nAfter the test's succesfull run, create manually a release with a new tag matching `${{ inputs.version }}`"
+            --head release/${{ inputs.version }} \
+            --title "[Automatic] Release PR ${{ inputs.version }}" \
+            --body "Automated release PR.\nAfter the test's succesfull run, create manually a release with a new tag matching ${{ inputs.version }}"
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -57,6 +57,26 @@ You must also have a [supported editor (and their associated plugin if needed)](
 
 ## How to install
 
+### Nix flakes
+
+Add this to your inputs in flake.nix:
+
+```nix
+notewrapper = {
+  url = "github:tomasriveral/notewrapper";
+};
+```
+If your flake already inputs nixpkgs and/or flake-utils, you can follow it:
+```nix
+notewrapper = {
+  url = "github:tomasriveral/notewrapper;
+  inputs.nixpkgs.follow = "nixpkgs";
+  inputs.flake-utils.follow = "flake-utils";
+};
+```
+
+### Building from source
+
 1. Install all required dependencies listed above.
 2. Ensure you have a supported editor installed.
 3. Clone the repository:
@@ -89,7 +109,7 @@ make
 
 ---
 
-## Packaging
+### Packaging
 
 There is currently no official package available for NoteWrapper.
 

flake.lock

@@ -20,11 +20,11 @@
     },
     "nixpkgs": {
       "locked": {
-        "lastModified": 1779508470,
-        "narHash": "sha256-Ap9KJX+5xHIn3bPIpfNgT6MEXdAECECwo4/rmlQD74M=",
+        "lastModified": 1779560665,
+        "narHash": "sha256-tpyBcxPpcQb8ukyNF7DoCwfSY3VPsxHoYwj00Cayv5o=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "29916453413845e54a65b8a1cf996842300cd299",
+        "rev": "64c08a7ca051951c8eae34e3e3cb1e202fe36786",
         "type": "github"
       },
       "original": {
@@ -34,10 +34,27 @@
         "type": "github"
       }
     },
+    "notewrapper": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1779896337,
+        "narHash": "sha256-Xw5vkiN4ei2dkzIRXP0DLSYG8QRjQ0MLvFx2akt96kk=",
+        "owner": "tomasriveral",
+        "repo": "NoteWrapper",
+        "rev": "4d228fb9118f22264863716ac2d74c4ad67edbf8",
+        "type": "github"
+      },
+      "original": {
+        "owner": "tomasriveral",
+        "repo": "NoteWrapper",
+        "type": "github"
+      }
+    },
     "root": {
       "inputs": {
         "flake-utils": "flake-utils",
-        "nixpkgs": "nixpkgs"
+        "nixpkgs": "nixpkgs",
+        "notewrapper": "notewrapper"
       }
     },
     "systems": {

flake.nix

@@ -4,23 +4,22 @@
   inputs = {
     nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
     flake-utils.url = "github:numtide/flake-utils";
+    notewrapper = {
+      url = "github:tomasriveral/NoteWrapper";
+      flake = false;
+    };
   };
 
-  outputs = { self, nixpkgs, flake-utils }:
+  outputs = { self, nixpkgs, flake-utils, notewrapper }:
     flake-utils.lib.eachDefaultSystem (system:
       let
         pkgs = import nixpkgs { inherit system; };
       in {
         packages.default = pkgs.stdenv.mkDerivation (finalAttrs: {
           pname = "notewrapper";
-          version = "2.1";
+          version = "v2.2";
 
-          src = pkgs.fetchFromGitHub {
-            owner = "tomasriveral";
-            repo = "NoteWrapper";
-            tag = "v${finalAttrs.version}";
-            hash = "sha256-JoI38n5RZ/s0n+Vr9Bri2oiFeyj7Xrt1AmglmcuMpmQ=";
-          };
+          src = notewrapper;
 
           nativeBuildInputs = with pkgs; [
             pkg-config
@@ -37,12 +36,8 @@
             gnused
           ];
 
-          makeFlags = [
-            "VERSION=2.0"
-          ];
-
           buildPhase = ''
-            make
+            make VERSION=${finalAttrs.version}
           '';
 
           installPhase = ''

src/main.c

@@ -529,9 +529,14 @@ backup_config_end:
                   shouldDebug); // check if editor is supported and if it is installed. If not, it
                                 // will throw an error.
 
+    int *backupMessage = malloc(sizeof(int)); // Used later to set the backuping message.
+    *backupMessage = 0;                       // default don't show the message
+    int forceBackup = 0;
     if (doesBackup) {
-        debug("Handling backup");
-        handleBackups(directoriesArray, numDirectories, backupDirectoriesArray, homedir, interval, (const char **)rsyncArgs, rsyncArgsNumber, shouldDebug);
+        debug("Handling normal backup");
+        forceBackup = 0;
+        handleBackups(directoriesArray, numDirectories, backupDirectoriesArray, homedir, interval, (const char **)rsyncArgs, rsyncArgsNumber, forceBackup, backupMessage, shouldDebug);
+        debug("backupMessage was set to %d by a normal backup", *backupMessage);
     }
 
     initscr(); // initialize ncurses
@@ -572,13 +577,26 @@ backup_config_end:
             }
             altDebug("└ ------------------------------\n");
         }
-
-        // adds "create a new vault" into the vaultsArray
-        const int extraOptions = 3;
+        int extraOptions = 3;
+        if (doesBackup) {
+            extraOptions++; // space for "Backup now" button
+        }
+        if (*backupMessage) {
+            extraOptions++;
+        }
         vaultsArray = realloc(vaultsArray, (vaultsCount + extraOptions) * sizeof(char *)); // resize vaultsArray to fit the extra options
-        vaultsArray[vaultsCount] = "Create a new vault";                                   // some more options that are not vaults
-        vaultsArray[vaultsCount + 1] = "Settings";
-        vaultsArray[vaultsCount + 2] = "Quit (Ctrl+C)";
+        int index = 0;
+        vaultsArray[vaultsCount + index++] = "Create a new vault"; // some more options that are not vaults
+        vaultsArray[vaultsCount + index++] = "Settings";
+        if (doesBackup) {
+            vaultsArray[vaultsCount + index++] = "Backup now";
+        }
+        vaultsArray[vaultsCount + index++] = "Quit (Ctrl+C)";
+        if (*backupMessage) {
+            vaultsArray[vaultsCount + index++] = "A backup was launched. Do not immediatly close the program. After a few seconds, you can safely ignore this message.";
+        };
+
+        *backupMessage = 0; // we reset it to show the message only once
 
         vaultSelected = ncursesSelect(vaultsArray, "Select vault to open (Use arrows or WASD, Enter to select):", vaultsCount, extraOptions, " ", "Or select an option below", "", shouldDebug);
 
@@ -594,7 +612,8 @@ backup_config_end:
         }
 
         debug("Selected vault: %s", vaultSelected);
-        if (strcmp(vaultSelected, "Create a new vault") != 0 && strcmp(vaultSelected, "Settings") != 0 && strcmp(vaultSelected, "Quit (Ctrl+C)") != 0) {
+        if (strcmp(vaultSelected, "Create a new vault") != 0 && strcmp(vaultSelected, "Settings") != 0 && strcmp(vaultSelected, "Quit (Ctrl+C)") != 0 && strcmp(vaultSelected, "Backup now") != 0 &&
+            strcmp(vaultSelected, "A backup was launched. Do not immediatly close the program. After a few seconds, you can safely ignore this message.") != 0) {
         note_selection:
             bypassSelectionVault = 0; // we must reset bypassSelectionVault to not get stuck in a
                                       // infinite loop of bypassing
@@ -731,6 +750,11 @@ backup_config_end:
         } else if (strcmp(vaultSelected, "Settings") == 0) {
             openEditor(configPath, editorToOpen, 0, 0,
                        shouldDebug); // as this is not a md file we set render and jumptoEnfOfFile to 0
+        } else if (strcmp(vaultSelected, "Backup now") == 0) {
+            debug("Running a forced backup");
+            forceBackup = 1;
+            handleBackups(directoriesArray, numDirectories, backupDirectoriesArray, homedir, interval, (const char **)rsyncArgs, rsyncArgsNumber, forceBackup, backupMessage, shouldDebug);
+            debug("backupMessage was set to %d by a normal backup", *backupMessage);
         } else if (strcmp(vaultSelected, "Quit (Ctrl+C)") == 0) {
             debug("The program was exited");
             shouldExit = 1;

src/utils.c

@@ -167,8 +167,9 @@ void initAppFilesAndDirs(const char *home, const int shouldDebug) {
 }
 
 void handleBackups(char **sourceDirectoryArray, const int sourceNumber, char **destinationDirectoryArray, const char *homeDir, const int interval, const char **rsyncArguments, const int rsyncArgumentsNumber,
-                   const int shouldDebug) {
+                   const int forceBackup, int *backupMessage, const int shouldDebug) {
     int shouldBackup = 0;
+
     time_t now = time(NULL);
     debug("Time since epoch is %ld", (long)now);
     char cacheFilePATH[PATH_MAX];
@@ -203,8 +204,12 @@ void handleBackups(char **sourceDirectoryArray, const int sourceNumber, char **d
             error(1, "program", "Invalid timestamp in cache file: %s", line);
         }
         double deltaTime = difftime(now, lastBackupTime);
-        if (deltaTime > interval) {
-            debug("(difftime) %f is greater than (interval) %d -> backuping...", deltaTime, interval);
+        if (deltaTime > interval || forceBackup) {
+            if (!forceBackup) {
+                debug("(difftime) %f is greater than (interval) %d -> backuping...", deltaTime, interval);
+            } else {
+                debug("Backup was forced. backuping...");
+            }
             shouldBackup = 1;
             cacheFile = fopen(cacheFilePATH, "w");
             if (!cacheFile) {
@@ -218,6 +223,7 @@ void handleBackups(char **sourceDirectoryArray, const int sourceNumber, char **d
     }
 
     if (shouldBackup) {
+        *backupMessage = 1;
         debug("A backup is needed");
         for (int i = 0; i < sourceNumber; i++) {
             debug("%s", destinationDirectoryArray[i]);

src/utils.h

@@ -81,7 +81,8 @@ If need launches in the background rsync to do the backuping.
 Each pair of source/destination will launch one rsync process.
 If a pair don't need to be backed up, the destination should be set to NULL.
 rsyncArgs is the array of arguments to be passed to rsync. Do not inclue destination or source. It
-will be added in the function.*/
+will be added in the function.
+backupMessage will be set to 1 if a backup was launched.*/
 void handleBackups(char **sourceDirectoryArray, const int sourceDirectoryNumber, char **destinationDirectoryArray, const char *homeDir, const int interval, const char **rsyncArgs, const int rsyncArgsNumber,
-                   const int shouldDebug);
+                   const int forceBackup, int *backupMessage, const int shouldDebug);
 #endif