mirror of
https://github.com/tomasriveral/NoteWrapper.git
synced 2026-10-10 08:55:22 +02:00
Compare commits
25
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
19610c1c51 | ||
|
|
39a3cb6bba | ||
|
|
0d5da72b13 | ||
|
|
e78a9ca669 | ||
|
|
c83a504648 | ||
|
|
2e301b0b52 | ||
|
|
c7a9d45a65 | ||
|
|
62da4cfb2e | ||
|
|
d56e7d9e4f | ||
|
|
449a9eaca6 | ||
|
|
edc979dccb | ||
|
|
5f37e48030 | ||
|
|
df0301fdcd | ||
|
|
518d4fd09c | ||
|
|
a83da3e1aa | ||
|
|
eb0d6b6e5d | ||
|
|
82d016fdd7 | ||
|
|
2e03edac2b | ||
|
|
689c3074c0 | ||
|
|
e54933e5fa | ||
|
|
3f9471531d | ||
|
|
ab1928551a | ||
|
|
e75c8e5815 | ||
|
|
693e85d974 | ||
|
|
b9f71f580a |
No files matched your search
@@ -28,6 +28,7 @@ jobs:
|
||||
pkg-config \
|
||||
libcjson-dev \
|
||||
libncurses-dev \
|
||||
libgit2-dev \
|
||||
git \
|
||||
neovim
|
||||
- name: Prepare environnement
|
||||
|
||||
+3
-1
@@ -10,7 +10,7 @@ This project aims to remain minimal, terminal-focused, and easy to extend. Contr
|
||||
|
||||
Please use the standardized debugging and error-handling functions defined in [/src/utils.c](./src/utils.c):
|
||||
|
||||
* `debug(...)`
|
||||
* `debug("message", ...)`
|
||||
Used for formatted debugging output (printf-style formatting).
|
||||
|
||||
* `altDebug(...)`
|
||||
@@ -21,6 +21,8 @@ Please use the standardized debugging and error-handling functions defined in [/
|
||||
|
||||
* `"user"`: errors caused by user input or configuration
|
||||
* `"program"`: internal or unexpected program errors
|
||||
* `warn(condition, "message", ...)`
|
||||
Used for formatted warning (printf-style formatting).
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -4,6 +4,8 @@ Note: This project fullfills all my usecases for now, so my main source for feat
|
||||
|
||||
[](https://deepwiki.com/tomasriveral/notewrapper)
|
||||
|
||||

|
||||
|
||||
## Why?
|
||||
|
||||
I started journaling and note-taking with **[Obsidian](https://obsidian.md/)** but wanted to use only free software. I also tried **[Logseq](https://logseq.com/)** and **[Joplin](https://github.com/laurent22/joplin)**, but I preferred a terminal-based workflow.
|
||||
@@ -41,6 +43,7 @@ Before building NoteWrapper, you must install the following dependencies:
|
||||
* `sed`
|
||||
* `ripgrep`
|
||||
* `fzf`
|
||||
* `libgit2`
|
||||
|
||||
You must also have a [supported editor (and their associated plugin if needed)](#editor-support) installed:
|
||||
|
||||
@@ -157,11 +160,13 @@ NoteWrapper relies on certain editor features, so not all functionality is suppo
|
||||
|
||||
### Features requiring editor support:
|
||||
|
||||
* **Bufferless rendering**: updates the rendered view while typing (without saving)
|
||||
* **Cursor following**: rendered view follows the cursor position
|
||||
* **Jump to end on open**: automatically moves the cursor to the end of the file
|
||||
* **Bufferless rendering**: updates the rendered view while typing (without saving). You won't need to save the file to see it updated in your browser.
|
||||
* **Cursor following**: rendered view follows the cursor position. When you scroll in your editor, it will automatically scroll your browser view.
|
||||
* **Jump to end on open**: automatically moves the cursor to the end of the file when oppening.
|
||||
|
||||
The first two features depend on [Vivify's editor integration](https://github.com/jannis-baum/Vivify?tab=readme-ov-file#existing-integration) and are mainly useful if you want external Markdown rendering in your browser.
|
||||
The first two features depend on [Vivify's editor integration](https://github.com/jannis-baum/Vivify?tab=readme-ov-file#existing-integration)[^1] and are mainly useful if you want external Markdown rendering in your browser.
|
||||
|
||||
[^1]: Eventhough the features are Vivify-related, please report bugs and ask questions in this repo.
|
||||
|
||||
If your editor does not support these features, you can implement a plugin using [Vivify's API](https://github.com/jannis-baum/Vivify?tab=readme-ov-file#editor-support).
|
||||
|
||||
@@ -200,7 +205,12 @@ Edit `~/.config/notewrapper/config.json`. If it does not exist, it will be creat
|
||||
"/other/paths/": "path/to/backup2"
|
||||
},
|
||||
"interval": "weekly",
|
||||
"rsyncArgs": ["-Lqah", "--update"]
|
||||
"rsyncArgs": ["-Lqah", "--update"],
|
||||
"git": {
|
||||
"enable": false,
|
||||
"name": "Example Example",
|
||||
"email": "mail@example.com"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
@@ -218,16 +228,21 @@ Edit `~/.config/notewrapper/config.json`. If it does not exist, it will be creat
|
||||
* `backup.directory`: backup's destination for each directory
|
||||
* `backup.interval`: backup frequency (`daily`, `weekly`, `monthly`, or integer)
|
||||
* `backup.rsyncArgs`: arguments passed to `rsync`
|
||||
* `git.enable`: enable git version control for backups
|
||||
* `git.name` and `git.email` are for the commits signature
|
||||
|
||||
Note:
|
||||
* Directories must end with `/`.
|
||||
* All directories used must exist.
|
||||
* Elements of `directory` and `backup.directory` must match exactly.
|
||||
* Directories set in `directory` but not in `backup.directory` won't be backed up.
|
||||
* Directories set in `backup.directory` but not in `directory` will be ignored.
|
||||
* `journalRegex` must match if the file name ends with `.md` and if it doesn't.
|
||||
* It is recommended to keep `-q` or `--quiet` flag in `rsyncArgs` to avoid interference with `ncurses`.
|
||||
* If `rsync` fails, you will see it inside `ncurses`.
|
||||
> [!NOTE]
|
||||
> * The git backup implementation relies a lot on the IO speed of your drive. A low speed one (or a web mounted one) could create blanks between closing a document and the TUI opening.
|
||||
> * Directories must end with `/`.
|
||||
> * All directories used must exist.
|
||||
> * Elements of `directory` and `backup.directory` must match exactly.
|
||||
> * Directories set in `directory` but not in `backup.directory` won't be backed up.
|
||||
> * Directories set in `backup.directory` but not in `directory` will be ignored.
|
||||
> * `journalRegex` must match if the file name ends with `.md` and if it doesn't.
|
||||
> * It is recommended to keep `-q` or `--quiet` flag in `rsyncArgs` to avoid interference with `ncurses`.
|
||||
> * If `rsync` fails, you will see it inside `ncurses`.
|
||||
> * If you want the git backup but without rsync, you can leave `backup.directory` empty or map each directory to itself. When enabled, git will apply to all your vaults.
|
||||
> * Each vault gets its own git repository that will be created the first time you select the vault with the option enabled.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -0,0 +1,190 @@
|
||||
Require echo
|
||||
|
||||
Set Shell "zsh"
|
||||
Set TypingSpeed 35ms
|
||||
Set FontSize 18
|
||||
Set Width 1800
|
||||
Set Height 900
|
||||
|
||||
Output demo.gif
|
||||
|
||||
# ─────────────────────────────────────────────────────────────────────
|
||||
# Introduction
|
||||
# ─────────────────────────────────────────────────────────────────────
|
||||
|
||||
Type "echo 'Welcome to NoteWrapper!'"
|
||||
Sleep 800ms
|
||||
Enter
|
||||
Sleep 1500ms
|
||||
|
||||
Type "notewrapper --help"
|
||||
Sleep 500ms
|
||||
Enter
|
||||
Sleep 4000ms
|
||||
|
||||
# ─────────────────────────────────────────────────────────────────────
|
||||
# Create / open a unified journal
|
||||
# ─────────────────────────────────────────────────────────────────────
|
||||
|
||||
Type "notewrapper"
|
||||
Sleep 700ms
|
||||
Enter
|
||||
Sleep 1500ms
|
||||
|
||||
Down
|
||||
Sleep 500ms
|
||||
Down
|
||||
Sleep 500ms
|
||||
Down
|
||||
Sleep 700ms
|
||||
|
||||
Enter
|
||||
Sleep 1200ms
|
||||
|
||||
Down
|
||||
Sleep 600ms
|
||||
Enter
|
||||
Sleep 1500ms
|
||||
|
||||
# Enter the editor
|
||||
Type "i"
|
||||
Sleep 800ms
|
||||
|
||||
Type "NoteWrapper uses standard Markdown files, so you can open your notes in any other application that supports Markdown."
|
||||
Sleep 700ms
|
||||
Enter
|
||||
Sleep 800ms
|
||||
|
||||
Type "This is a unified journal: all your daily entries live in the same file. You can also configure NoteWrapper to use monthly or other time-based entries."
|
||||
Sleep 700ms
|
||||
Enter
|
||||
Sleep 800ms
|
||||
|
||||
Type "And, although you can't see it in this demo, this Markdown file is rendered live in my browser thanks to Vivify!"
|
||||
Sleep 1500ms
|
||||
Sleep 3000ms
|
||||
|
||||
# Leave the editor
|
||||
Escape
|
||||
Sleep 500ms
|
||||
Type ":q!"
|
||||
Sleep 800ms
|
||||
Enter
|
||||
Sleep 1500ms
|
||||
|
||||
# ─────────────────────────────────────────────────────────────────────
|
||||
# Create / open a divided journal
|
||||
# ─────────────────────────────────────────────────────────────────────
|
||||
|
||||
Down
|
||||
Sleep 500ms
|
||||
Down
|
||||
Sleep 500ms
|
||||
Down
|
||||
Sleep 700ms
|
||||
|
||||
Enter
|
||||
Sleep 2000ms
|
||||
|
||||
Enter
|
||||
Sleep 1000ms
|
||||
|
||||
Type "i"
|
||||
Sleep 800ms
|
||||
|
||||
Type "And this is a divided journal."
|
||||
Sleep 500ms
|
||||
Type " It uses one file per entry."
|
||||
Sleep 700ms
|
||||
Enter
|
||||
Sleep 1000ms
|
||||
|
||||
Type "Find the dates and journal divisions a little too cumbersome?"
|
||||
Sleep 700ms
|
||||
Enter
|
||||
Sleep 1500ms
|
||||
|
||||
Type "Don't worry: NoteWrapper also works with basic notes."
|
||||
Sleep 800ms
|
||||
|
||||
Type " It distinguishes them using a regular expression, which defaults to `.*journal.*`."
|
||||
Sleep 800ms
|
||||
Enter
|
||||
Sleep 700ms
|
||||
|
||||
Type " The unified or divided journal mode is chosen when you first create the journal."
|
||||
Sleep 1000ms
|
||||
Enter
|
||||
Sleep 1500ms
|
||||
|
||||
# ─────────────────────────────────────────────────────────────────────
|
||||
# Search
|
||||
# ─────────────────────────────────────────────────────────────────────
|
||||
|
||||
Type "Let me show you one last cool feature."
|
||||
Sleep 1000ms
|
||||
|
||||
Type " Have you ever forgotten when or where you wrote something?"
|
||||
Sleep 1000ms
|
||||
Enter
|
||||
Sleep 800ms
|
||||
|
||||
Type "Well ... NoteWrapper was made for you!"
|
||||
Sleep 1500ms
|
||||
|
||||
Escape
|
||||
Sleep 500ms
|
||||
Type ":q!"
|
||||
Sleep 800ms
|
||||
Enter
|
||||
Sleep 1500ms
|
||||
|
||||
# Navigate to search
|
||||
Down
|
||||
Sleep 500ms
|
||||
Down
|
||||
Sleep 500ms
|
||||
Down
|
||||
Sleep 800ms
|
||||
|
||||
Enter
|
||||
Sleep 1500ms
|
||||
|
||||
Down
|
||||
Sleep 500ms
|
||||
Down
|
||||
Sleep 800ms
|
||||
|
||||
Enter
|
||||
Sleep 2000ms
|
||||
|
||||
# Search all notes with fzf
|
||||
Type "c"
|
||||
Sleep 300ms
|
||||
Type "o"
|
||||
Sleep 300ms
|
||||
Type "o"
|
||||
Sleep 300ms
|
||||
Type "l"
|
||||
Sleep 1500ms
|
||||
|
||||
# Show the search result / preview
|
||||
Up
|
||||
Sleep 2000ms
|
||||
Enter
|
||||
Sleep 1000ms
|
||||
|
||||
# ─────────────────────────────────────────────────────────────────────
|
||||
# Final note
|
||||
# ─────────────────────────────────────────────────────────────────────
|
||||
|
||||
Type "i"
|
||||
Sleep 700ms
|
||||
|
||||
Type "Never lose a note."
|
||||
Sleep 1500ms
|
||||
Enter
|
||||
Sleep 1000ms
|
||||
|
||||
Type "P. S. Don't mind the broken fzf preview. Normally, you'll see the context around your search result, but sometimes `sed` breaks when fzf is opened for the first time."
|
||||
Sleep 5000ms
|
||||
Generated
+3
-3
@@ -20,11 +20,11 @@
|
||||
},
|
||||
"nixpkgs": {
|
||||
"locked": {
|
||||
"lastModified": 1783776592,
|
||||
"narHash": "sha256-UgCQzxeWI75XM8G+hPrPh+MKzEPjG3SpAj7dtqSbksA=",
|
||||
"lastModified": 1786862985,
|
||||
"narHash": "sha256-FBJRXmbGXiSUDvYEbfLYRkckayyZ6SK1UEqhCrIZ2Cs=",
|
||||
"owner": "NixOS",
|
||||
"repo": "nixpkgs",
|
||||
"rev": "e7a3ca8092b61ff85b6a45bf863ea2b2d6a661b3",
|
||||
"rev": "e5bdc4a41d4c072fe1e3787eaa0320a384741d44",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
|
||||
@@ -30,6 +30,7 @@
|
||||
ripgrep
|
||||
fzf
|
||||
gnused
|
||||
libgit2
|
||||
];
|
||||
|
||||
buildPhase = ''
|
||||
@@ -51,6 +52,8 @@
|
||||
valgrind
|
||||
clang-tools
|
||||
gnumake
|
||||
libgit2
|
||||
vhs
|
||||
];
|
||||
};
|
||||
|
||||
|
||||
@@ -4,9 +4,9 @@ VERSION := $(shell git describe --tags --always --dirty)
|
||||
|
||||
CFLAGS := -Wall -Wextra -Werror -O2 \
|
||||
-DVERSION=\"$(VERSION)\" \
|
||||
$(shell pkg-config --cflags libcjson ncurses)
|
||||
$(shell pkg-config --cflags libcjson ncurses libgit2)
|
||||
|
||||
LDFLAGS := $(shell pkg-config --libs libcjson ncurses)
|
||||
LDFLAGS := $(shell pkg-config --libs libcjson ncurses libgit2)
|
||||
|
||||
SRC := src/main.c src/ui.c src/utils.c src/notes.c
|
||||
TARGET := notewrapper
|
||||
|
||||
+59
-7
@@ -96,7 +96,14 @@ int main(int argc, char *argv[]) {
|
||||
debug("Parsing the JSON config");
|
||||
|
||||
cJSON *json = cJSON_Parse(data);
|
||||
|
||||
if (!json) {
|
||||
const char *error_ptr = cJSON_GetErrorPtr();
|
||||
|
||||
if (error_ptr) {
|
||||
error(1, "program", "JSON parse error near: %.30s", error_ptr);
|
||||
}
|
||||
|
||||
free(data);
|
||||
}
|
||||
error(!json, "program", "JSON parse error");
|
||||
@@ -210,6 +217,9 @@ int main(int argc, char *argv[]) {
|
||||
char **backupDirectoriesArray = malloc(numDirectories * sizeof(char *));
|
||||
char **rsyncArgs = NULL;
|
||||
int rsyncArgsNumber = 0;
|
||||
int gitEnabled = 0;
|
||||
char *gitSignatureName = NULL;
|
||||
char *gitSignatureEmail = NULL;
|
||||
cJSON *backupJSON = cJSON_GetObjectItem(json, "backup");
|
||||
if (backupJSON && cJSON_IsObject(backupJSON)) {
|
||||
cJSON *doesBackupJSON = cJSON_GetObjectItem(backupJSON, "enable");
|
||||
@@ -285,11 +295,36 @@ int main(int argc, char *argv[]) {
|
||||
"value is from an unexpected type",
|
||||
configPath);
|
||||
}
|
||||
|
||||
// Configure Git backup
|
||||
cJSON *gitJSON = cJSON_GetObjectItem(backupJSON, "git");
|
||||
|
||||
if (gitJSON && cJSON_IsObject(gitJSON)) {
|
||||
cJSON *gitEnableJSON = cJSON_GetObjectItem(gitJSON, "enable");
|
||||
cJSON *gitNameJSON = cJSON_GetObjectItem(gitJSON, "name");
|
||||
cJSON *gitEmailJSON = cJSON_GetObjectItem(gitJSON, "email");
|
||||
|
||||
error(!gitEnableJSON || !cJSON_IsBool(gitEnableJSON), "user", "Entry \"git.enable\" in %s must be a bool.", configPath);
|
||||
error(!gitNameJSON || !cJSON_IsString(gitNameJSON), "user", "Entry \"git.name\" in %s must be a string.", configPath);
|
||||
error(!gitEmailJSON || !cJSON_IsString(gitEmailJSON), "user", "Entry \"git.email\" in %s must be a string.", configPath);
|
||||
|
||||
gitEnabled = cJSON_IsTrue(gitEnableJSON) ? 1 : 0;
|
||||
|
||||
if (gitEnabled) {
|
||||
gitSignatureName = strdup(cJSON_GetStringValue(gitNameJSON));
|
||||
gitSignatureEmail = strdup(cJSON_GetStringValue(gitEmailJSON));
|
||||
|
||||
error(gitSignatureName == NULL || gitSignatureEmail == NULL, "program", "malloc failed");
|
||||
|
||||
debug("git in %s is enabled with name \"%s\" and email \"%s\"", configPath, gitSignatureName, gitSignatureEmail);
|
||||
} else {
|
||||
debug("git in %s is disabled", configPath);
|
||||
}
|
||||
} else {
|
||||
error(1, "user", "Entry \"git\" in %s must be an object containing \"enable\", \"name\", and \"email\".", configPath);
|
||||
}
|
||||
} else {
|
||||
error(1, "user",
|
||||
"%s did not contained a enable value inside the backup section or the value is "
|
||||
"from an unexpected type",
|
||||
configPath);
|
||||
error(1, "user", "%s did not contained a enable value inside the backup section or the value is from an unexpected type", configPath);
|
||||
}
|
||||
// handle rsyncs array of arguments.
|
||||
cJSON *rsyncArgsJSON = cJSON_GetObjectItem(backupJSON, "rsyncArgs");
|
||||
@@ -314,9 +349,7 @@ int main(int argc, char *argv[]) {
|
||||
configPath);
|
||||
}
|
||||
} else {
|
||||
debug("In %s, \"backup\" wasn't set or we encountered a abnormal type. Defaulting to "
|
||||
"{\"enable\": false}.",
|
||||
configPath);
|
||||
debug("In %s, \"backup\" wasn't set or we encountered a abnormal type. Defaulting to {\"enable\": false}.", configPath);
|
||||
}
|
||||
backup_config_end:
|
||||
|
||||
@@ -541,6 +574,12 @@ backup_config_end:
|
||||
|
||||
initscr(); // initialize ncurses
|
||||
|
||||
// initialized libgit2
|
||||
if (gitEnabled) {
|
||||
int libgit2InitializationTimes = git_libgit2_init();
|
||||
error(libgit2InitializationTimes != 1, "program", "libgit2 has been initialized %d times (instead of one)", libgit2InitializationTimes);
|
||||
}
|
||||
|
||||
int shouldExit = 0;
|
||||
while (!shouldExit) {
|
||||
// this loop is the vault selector
|
||||
@@ -621,6 +660,11 @@ backup_config_end:
|
||||
int shouldChangeVault = 0;
|
||||
// we must find the directory from which the vault comes again.
|
||||
char *notesDirectoryString = getDirectoryFromVault(vaultSelected, vaultsArray, vaultsCount, vaultsCountForEachDirectory, directoriesArray, numDirectories, shouldDebug);
|
||||
|
||||
if (gitEnabled) { // we check if we need to git init the vault each time we enter it
|
||||
ensureGitDirectory(notesDirectoryString, vaultSelected, gitSignatureName, gitSignatureEmail, shouldDebug);
|
||||
}
|
||||
|
||||
while (!shouldExit && !shouldChangeVault) {
|
||||
// this loop is the note selector
|
||||
int filesCount = 0;
|
||||
@@ -723,6 +767,14 @@ backup_config_end:
|
||||
free(fullPath);
|
||||
}
|
||||
free(returnNoteSelection);
|
||||
if (gitEnabled) { // After closing a file, we need to update the git repo (if git is enable
|
||||
char *date = getDateAndTime();
|
||||
char *commitMsg = malloc(29);
|
||||
snprintf(commitMsg, 29, "Update - %s", date);
|
||||
gitBackupUpdate(notesDirectoryString, vaultSelected, gitSignatureName, gitSignatureEmail, commitMsg, shouldDebug);
|
||||
free(date);
|
||||
free(commitMsg);
|
||||
}
|
||||
} else if (strcmp(noteSelected, "Create new note") == 0) {
|
||||
note_creation:
|
||||
noteSelected = createNewNote(notesDirectoryString, vaultSelected, bypassSelectionNote, bypassSelectionNoteValue, journalRegex, shouldDebug);
|
||||
|
||||
+206
-2
@@ -71,6 +71,26 @@ void _error(const int shouldDebug, const int condition, const char *type, const
|
||||
exit(1);
|
||||
}
|
||||
}
|
||||
void _warn(const int condition, const char *file, const int line, const char *function, const char *message, ...) { // use for warnings that should always be shown
|
||||
if (condition) {
|
||||
fflush(stdout);
|
||||
fflush(stderr);
|
||||
|
||||
va_list args;
|
||||
va_start(args, message);
|
||||
|
||||
int h, m, s;
|
||||
getCurrentTime(&h, &m, &s);
|
||||
|
||||
fprintf(stdout, "\e[0;33m[WARNING -- %d:%d:%d] From file %s line %d function %s:\e[0m\n", h, m, s, file, line, function);
|
||||
|
||||
vfprintf(stdout, message, args);
|
||||
|
||||
fprintf(stdout, "\e[0m\n");
|
||||
|
||||
va_end(args);
|
||||
}
|
||||
}
|
||||
|
||||
static void copyDir(const char *source, const char *destination, const char **rsyncArgs, const int rsyncArgsNumber, const int shouldDebug) {
|
||||
debug("Backuping... source: %s and destination: %s", source, destination);
|
||||
@@ -113,6 +133,175 @@ static void ensureDir(const char *path, const int shouldDebug) {
|
||||
}
|
||||
}
|
||||
|
||||
static void slowGitWarning(struct timespec start, int *wasShown) {
|
||||
if (!*wasShown) {
|
||||
struct timespec now;
|
||||
clock_gettime(CLOCK_MONOTONIC, &now);
|
||||
|
||||
double elapsed = (double)(now.tv_sec - start.tv_sec) + (double)(now.tv_nsec - start.tv_nsec) / 1e9;
|
||||
|
||||
warn(elapsed > 0.3, "Git operations are taking too much time. You drive might be slow. Please do not stop the program.");
|
||||
if (elapsed > 0.3) {
|
||||
*wasShown = 1;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void ensureGitDirectory(const char *path, const char *vault, const char *signatureName, const char *signatureEmail, const int shouldDebug) {
|
||||
git_repository *repo = NULL;
|
||||
char *fullPath = malloc(PATH_MAX);
|
||||
snprintf(fullPath, PATH_MAX, "%s/%s", path, vault);
|
||||
|
||||
int git_repo_error_code = git_repository_open(&repo, fullPath);
|
||||
if (git_repo_error_code) { // error (most probably that the git repo wasn't initialized)
|
||||
int git_init_error_code = git_repository_init(&repo, fullPath, 0); // the 0 indicates that the directory isn't bare. See https://libgit2.org/docs/reference/main/repository/git_repository_init.html
|
||||
error(git_init_error_code, "program", "git initialization didn't worked. Error code : %d\nSee https://libgit2.org/docs/reference/main/repository/git_repository_init.html for documentation\n\n%s",
|
||||
git_init_error_code, git_error_last()->message);
|
||||
debug("git repo %s was initialized.", fullPath);
|
||||
|
||||
// we need to setup the .gitignore
|
||||
char *gitignorePath = malloc(PATH_MAX);
|
||||
snprintf(gitignorePath, PATH_MAX, "%s/.gitignore", fullPath);
|
||||
FILE *gitignore = fopen(gitignorePath, "a");
|
||||
error(gitignore == NULL, "program", "failed to open/create %s\n%s", gitignorePath, git_error_last()->message);
|
||||
fputs("*\n", gitignore);
|
||||
fputs("!*/\n", gitignore);
|
||||
fputs("!*.md\n", gitignore);
|
||||
fclose(gitignore);
|
||||
debug("Succesfully wrote .gitignore to %s", gitignorePath);
|
||||
git_repository_free(repo); // we free to be able to open it in gitBackupUpdate()
|
||||
char *date = getDateAndTime();
|
||||
char *commitMsg = malloc(37);
|
||||
snprintf(commitMsg, 37, "Initial commit - %s", date);
|
||||
gitBackupUpdate(path, vault, signatureName, signatureEmail, commitMsg, shouldDebug);
|
||||
free(date);
|
||||
free(commitMsg);
|
||||
} else { // the git repo already exists
|
||||
debug("%s is already a git repo. Skipping initialization...", fullPath);
|
||||
git_repository_free(repo);
|
||||
}
|
||||
|
||||
free(fullPath);
|
||||
}
|
||||
|
||||
void gitBackupUpdate(const char *path, const char *vault, const char *signatureName, const char *signatureEmail, const char *commitMsg, const int shouldDebug) {
|
||||
// on slow drive or WebDav mounted drive this git operations are pretty slow. We'll just show a warning to avoid the user closing the program.
|
||||
struct timespec start;
|
||||
clock_gettime(CLOCK_MONOTONIC, &start);
|
||||
|
||||
git_repository *repo = NULL;
|
||||
git_index *index = NULL;
|
||||
git_tree *tree = NULL;
|
||||
git_tree *head_tree = NULL;
|
||||
git_commit *head_commit = NULL;
|
||||
git_signature *signature = NULL;
|
||||
git_diff *diff = NULL;
|
||||
|
||||
git_oid tree_id;
|
||||
git_oid commit_id;
|
||||
|
||||
int slowGitWarningAlreadyShown = 0;
|
||||
|
||||
char *fullPath = malloc(PATH_MAX);
|
||||
|
||||
error(fullPath == NULL, "program", "Failed to allocate path");
|
||||
|
||||
snprintf(fullPath, PATH_MAX, "%s/%s", path, vault);
|
||||
|
||||
/* Open repository */
|
||||
int return_code = git_repository_open(&repo, fullPath);
|
||||
|
||||
error(return_code, "program", "Failed to open Git repository\n%s", git_error_last()->message);
|
||||
slowGitWarning(start, &slowGitWarningAlreadyShown);
|
||||
|
||||
/* Get the index */
|
||||
return_code = git_repository_index(&index, repo);
|
||||
error(return_code, "program", "Failed to get Git index\n%s", git_error_last()->message);
|
||||
slowGitWarning(start, &slowGitWarningAlreadyShown);
|
||||
|
||||
/* git add . */
|
||||
return_code = git_index_add_all(index, NULL, 0, NULL, NULL);
|
||||
error(return_code, "program", "Failed to add files\n%s", git_error_last()->message);
|
||||
slowGitWarning(start, &slowGitWarningAlreadyShown);
|
||||
|
||||
return_code = git_index_write(index);
|
||||
error(return_code, "program", "Failed to write index\n%s", git_error_last()->message);
|
||||
slowGitWarning(start, &slowGitWarningAlreadyShown);
|
||||
|
||||
/*
|
||||
* Check whether there are changes to commit.
|
||||
*
|
||||
* For a new repository there is no HEAD yet, so the index
|
||||
* itself tells us whether there is anything to commit.
|
||||
*/
|
||||
int has_changes = 0;
|
||||
|
||||
if (git_repository_head_unborn(repo)) {
|
||||
has_changes = git_index_entrycount(index) > 0;
|
||||
} else {
|
||||
git_oid head_oid;
|
||||
|
||||
return_code = git_reference_name_to_id(&head_oid, repo, "HEAD");
|
||||
error(return_code, "program", "Failed to get HEAD\n%s", git_error_last()->message);
|
||||
slowGitWarning(start, &slowGitWarningAlreadyShown);
|
||||
|
||||
return_code = git_commit_lookup(&head_commit, repo, &head_oid);
|
||||
error(return_code, "program", "Failed to lookup HEAD commit\n%s", git_error_last()->message);
|
||||
slowGitWarning(start, &slowGitWarningAlreadyShown);
|
||||
|
||||
return_code = git_commit_tree(&head_tree, head_commit);
|
||||
error(return_code, "program", "Failed to get HEAD tree\n%s", git_error_last()->message);
|
||||
slowGitWarning(start, &slowGitWarningAlreadyShown);
|
||||
|
||||
return_code = git_diff_tree_to_index(&diff, repo, head_tree, index, NULL);
|
||||
error(return_code, "program", "Failed to create diff\n%s", git_error_last()->message);
|
||||
slowGitWarning(start, &slowGitWarningAlreadyShown);
|
||||
|
||||
has_changes = git_diff_num_deltas(diff) > 0;
|
||||
}
|
||||
|
||||
/* Nothing changed, so don't create a commit */
|
||||
if (!has_changes) {
|
||||
debug("No changes to commit in %s", fullPath);
|
||||
goto cleanup;
|
||||
}
|
||||
|
||||
/* index → tree */
|
||||
return_code = git_index_write_tree(&tree_id, index);
|
||||
error(return_code, "program", "Failed to write tree\n%s", git_error_last()->message);
|
||||
slowGitWarning(start, &slowGitWarningAlreadyShown);
|
||||
|
||||
return_code = git_tree_lookup(&tree, repo, &tree_id);
|
||||
error(return_code, "program", "Failed to lookup tree\n%s", git_error_last()->message);
|
||||
slowGitWarning(start, &slowGitWarningAlreadyShown);
|
||||
|
||||
/* Author/committer */
|
||||
return_code = git_signature_now(&signature, signatureName, signatureEmail);
|
||||
error(return_code, "program", "Failed to create signature\n%s", git_error_last()->message);
|
||||
slowGitWarning(start, &slowGitWarningAlreadyShown);
|
||||
|
||||
/* Create commit */
|
||||
if (git_repository_head_unborn(repo)) {
|
||||
return_code = git_commit_create_v(&commit_id, repo, "HEAD", signature, signature, NULL, commitMsg, tree, 0);
|
||||
} else {
|
||||
return_code = git_commit_create_v(&commit_id, repo, "HEAD", signature, signature, NULL, commitMsg, tree, 1, head_commit);
|
||||
}
|
||||
error(return_code, "program", "Failed to create commit\n%s", git_error_last()->message);
|
||||
slowGitWarning(start, &slowGitWarningAlreadyShown);
|
||||
|
||||
debug("Created commit %s in %s", commitMsg, fullPath);
|
||||
|
||||
cleanup:
|
||||
git_diff_free(diff);
|
||||
git_signature_free(signature);
|
||||
git_tree_free(tree);
|
||||
git_tree_free(head_tree);
|
||||
git_commit_free(head_commit);
|
||||
git_index_free(index);
|
||||
git_repository_free(repo);
|
||||
free(fullPath);
|
||||
}
|
||||
|
||||
void initAppFilesAndDirs(const char *home, const int shouldDebug) {
|
||||
// sometimes .cache and .config doesn't exist. Such as with github actions machines
|
||||
char config_dir[PATH_MAX];
|
||||
@@ -157,15 +346,30 @@ void initAppFilesAndDirs(const char *home, const int shouldDebug) {
|
||||
" \"enable\": false,\n"
|
||||
" \"directory\": {\n"
|
||||
" \"~/Documents/\": \"path/to/backup/\"\n"
|
||||
" },\n"
|
||||
" },\n"
|
||||
" \"interval\": \"weekly\",\n"
|
||||
" \"rsyncArgs\": [\"-Lqah\", \"--update\"]\n"
|
||||
" \"rsyncArgs\": [\"-Lqah\", \"--update\"],\n"
|
||||
" \"git\": {\n"
|
||||
" \"enable\": false,\n"
|
||||
" \"email\": \"mail@example.com\",\n"
|
||||
" \"name\": \"Example Example\"\n"
|
||||
" }\n"
|
||||
" }\n"
|
||||
"}\n");
|
||||
|
||||
fclose(w);
|
||||
}
|
||||
|
||||
char *getDateAndTime() {
|
||||
char *return_value = malloc(20);
|
||||
time_t now = time(NULL);
|
||||
struct tm tm_now;
|
||||
localtime_r(&now, &tm_now);
|
||||
|
||||
strftime(return_value, 20, "%Y-%m-%d %H:%M:%S", &tm_now);
|
||||
return return_value;
|
||||
}
|
||||
|
||||
void handleBackups(char **sourceDirectoryArray, const int sourceNumber, char **destinationDirectoryArray, const char *homeDir, const int interval, const char **rsyncArguments, const int rsyncArgumentsNumber,
|
||||
const int forceBackup, int *backupMessage, const int shouldDebug) {
|
||||
int shouldBackup = 0;
|
||||
|
||||
+13
@@ -6,6 +6,7 @@
|
||||
#include <dirent.h>
|
||||
#include <errno.h>
|
||||
#include <ftw.h>
|
||||
#include <git2.h>
|
||||
#include <limits.h>
|
||||
#include <ncurses.h>
|
||||
#include <pwd.h>
|
||||
@@ -17,6 +18,7 @@
|
||||
#include <sys/wait.h>
|
||||
#include <time.h>
|
||||
#include <unistd.h>
|
||||
|
||||
#ifndef VERSION
|
||||
#define VERSION "dev"
|
||||
#endif
|
||||
@@ -29,6 +31,7 @@
|
||||
#define debug(message, ...) _debug(shouldDebug, __FILE__, __LINE__, __func__, message, ##__VA_ARGS__)
|
||||
#define altDebug(message, ...) _altDebug(shouldDebug, message, ##__VA_ARGS__)
|
||||
#define error(condition, type, message, ...) _error(shouldDebug, condition, type, __FILE__, __LINE__, __func__, message, ##__VA_ARGS__)
|
||||
#define warn(condition, message, ...) _warn(condition, __FILE__, __LINE__, __func__, message, ##__VA_ARGS__)
|
||||
// you must edit this two values if you want to add suport for an editor
|
||||
extern const char *supportedEditor[]; // array of supported editors
|
||||
extern const int numEditors; // number of supported editors
|
||||
@@ -51,6 +54,8 @@ void _debug(const int d, const char *file, const int line, const char *function,
|
||||
void _altDebug(const int d, const char *message, ...);
|
||||
// formated error.
|
||||
void _error(const int shouldDebug, const int condition, const char *type, const char *file, const int line, const char *function, const char *message, ...);
|
||||
// formated warn
|
||||
void _warn(const int condition, const char *file, const int line, const char *function, const char *message, ...);
|
||||
// Returns 1 if the string is in the array.
|
||||
// Returns 0 if the string is not in the array.
|
||||
// If you want to only check the first n elements of the array, pass n as len.
|
||||
@@ -85,4 +90,12 @@ 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 forceBackup, int *backupMessage, const int shouldDebug);
|
||||
/*Equivalent of git init.
|
||||
If the directory wasn't git initialized. We do it.*/
|
||||
void ensureGitDirectory(const char *path, const char *vault, const char *signatureName, const char *signatureEmail, const int shouldDebug);
|
||||
/*Configures git, stages everything, commits everything*/
|
||||
void gitBackupUpdate(const char *path, const char *vault, const char *signatureName, const char *signatureEmail, const char *commitMsg, const int shouldDebug);
|
||||
// yyyy-mm-dd hh:mm:ss
|
||||
// Don't forget to free the pointer.
|
||||
char *getDateAndTime();
|
||||
#endif
|
||||
Reference in new issue
Block a user