Compare commits
43 Commits
v0.1
...
bc0233962a
| Author | SHA1 | Date | |
|---|---|---|---|
| bc0233962a | |||
| c8f88b2410 | |||
| a9bdca55b5 | |||
| 0dd0a81a64 | |||
| 53149ea9db | |||
| c63b3c4ee2 | |||
| d228f551ab | |||
| 3fe908738f | |||
| 8f04082d65 | |||
| 7f04d84b30 | |||
| 3150e877c7 | |||
| 26a6900555 | |||
| 76fa32da39 | |||
| 609d9712a6 | |||
| de4650d1ac | |||
| 7656da2a71 | |||
| 6c78213587 | |||
| 2a3c188f02 | |||
| 6f268c05cd | |||
| 5144465792 | |||
| 83061bd54b | |||
| b613c25f98 | |||
| 374d7e08c8 | |||
| 7df51a6980 | |||
| 4079a53c2b | |||
| 0c742eccd4 | |||
| 095a2e3810 | |||
| 498c7371b7 | |||
| 8d5223343b | |||
| f7d4a54a3d | |||
| 3db94cf627 | |||
| 50c438e656 | |||
| a72c2c73d2 | |||
| 23fdb4c3d2 | |||
| 9545410139 | |||
| c2342b52a6 | |||
| 7aa85ce5af | |||
| 5b292f6971 | |||
| 74a75f1b4b | |||
| ee8e6994f3 | |||
| 2df8fcf1bc | |||
| 9a5aaea387 | |||
| 5bbde62142 |
1
.gitignore
vendored
Normal file
1
.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
||||
fzf-vjour
|
||||
85
README.md
85
README.md
@@ -1,49 +1,56 @@
|
||||
A [fzf](https://github.com/junegunn/fzf)-based **journaling and notes** application with CalDav support.
|
||||
A [fzf](https://github.com/junegunn/fzf)-based **journaling, notes, and tasks** application with CalDav support.
|
||||
If you are interested in this, then you may also be interested in the
|
||||
corresponding calendar application
|
||||
[fzf-vcal](https://github.com/baumea/fzf-vcal).
|
||||
|
||||
Description and Use Case
|
||||
------------------------
|
||||
This application allows for a keyboard-controlled maneuvering of your notes and journal entries.
|
||||
A journal entry is nothing more than a note associated with a specific date.
|
||||
These entries are stored as [iCalendar](https://datatracker.ietf.org/doc/html/rfc5545) files of the type `VJOURNAL`.
|
||||
This application allows for a keyboard-controlled maneuvering of your notes, journal entries, and tasks.
|
||||
These entries are stored as [iCalendar](https://datatracker.ietf.org/doc/html/rfc5545) files of the type `VJOURNAL` and `VTODO`.
|
||||
|
||||
For instance, you could use this application as a minimalistic terminal-based counterpart of [jtx Board](https://jtx.techbee.at/) in a setup
|
||||
For instance, you could use this application as a terminal-based counterpart of [jtx Board](https://jtx.techbee.at/) in a setup
|
||||
with a CalDav server, such as [Radicale](https://radicale.org/), and a synchronization tool like [vdirsyncer](http://vdirsyncer.pimutils.org/).
|
||||
|
||||
Installation
|
||||
------------
|
||||
Just copy the file to your preferred location, e.g., `~/.local/bin`, and make it executable.
|
||||
|
||||
### Manual
|
||||
|
||||
Run `./scripts/build.sh`, then copy `fzf-vjour` to your preferred location, e.g., `~/.local/bin`, and make it executable.
|
||||
|
||||
### Requirements
|
||||
This is a POSIX script with inline `python3` elements.
|
||||
Make sure you have [fzf](https://github.com/junegunn/fzf), [batcat](https://github.com/sharkdp/bat), and [yq](https://github.com/mikefarah/yq) installed.
|
||||
For the `python3` code, we also require [icalendar](https://pypi.org/project/icalendar/).
|
||||
This is a POSIX script with inline `awk` elements.
|
||||
Make sure you have [fzf](https://github.com/junegunn/fzf) installed.
|
||||
I also suggest to install [batcat](https://github.com/sharkdp/bat) for colorful previews.
|
||||
|
||||
### Arch Linux
|
||||
|
||||
```bash
|
||||
yay -S fzf-vjour-git
|
||||
```
|
||||
|
||||
Configuration
|
||||
--------------
|
||||
This application is configured with a YAML file located at `$HOME/.config/fzf-vjour/config.yaml`.
|
||||
The entry `datadir` specifies the root directory of your journal and note entries.
|
||||
This application is configured with a file located at `$HOME/.config/fzf-vjour/config`.
|
||||
The entry `ROOT` specifies the root directory of your journal and note entries.
|
||||
This directory may contain several subfolders, called _collections_.
|
||||
The entry `collections` is a list, where each item specifies a subfolder, given by `name`, and a label, given by `label` (any string).
|
||||
The entry `COLLECTION_LABELS` is a `;`-delimited list, where each item specifies a subfolder and a label (see example below).
|
||||
In the application, the user sees the collection labels instead of the collection names.
|
||||
This is particularly useful, because some servers use randomly generated names.
|
||||
Finally, a third entry `sync_cmd` specifies the command to be executed for synchronizing.
|
||||
Finally, a third entry `SYNC_CMD` specifies the command to be executed for synchronizing.
|
||||
|
||||
Consider the following example:
|
||||
```yaml
|
||||
datadir: ~/.journal
|
||||
sync_cmd: vdirsyncer sync journals
|
||||
collections:
|
||||
- name: 12cacb18-d3e1-4ad4-a1d0-e5b209012e85
|
||||
label: 💼
|
||||
- name: 745ae7a0-d723-4cd8-80c4-75f52f5b7d90
|
||||
label: 🏡
|
||||
```sh
|
||||
ROOT=~/.journal/
|
||||
COLLECTION_LABELS="745ae7a0-d723-4cd8-80c4-75f52f5b7d90=shared 👫🏼;12cacb18-d3e1-4ad4-a1d0-e5b209012e85=work 💼;"
|
||||
SYNC_CMD="vdirsyncer sync journals"
|
||||
```
|
||||
|
||||
|
||||
Here the files are stored in
|
||||
`~/.journal/12cacb18-d3e1-4ad4-a1d0-e5b209012e85` (work-related entries)
|
||||
and
|
||||
`~/.journal/745ae7a0-d723-4cd8-80c4-75f52f5b7d90` (personal collection).
|
||||
`~/.journal/745ae7a0-d723-4cd8-80c4-75f52f5b7d90` (shared collection).
|
||||
|
||||
This configuration will work well with a `vdirsyncer` configuration such as
|
||||
```confini
|
||||
@@ -59,20 +66,40 @@ path = "~/.journal"
|
||||
|
||||
[storage remote]
|
||||
type = "caldav"
|
||||
item_types = ["VJOURNAL"]
|
||||
item_types = ["VJOURNAL", "VTODO"]
|
||||
...
|
||||
```
|
||||
|
||||
Usage
|
||||
-----
|
||||
Use the default `fzf` keys to navigate your notes. In addition, there are the following keybindings:
|
||||
Use the default `fzf` keys to navigate your notes, e.g., `ctrl-j` and `ctrl-k` for going down/up in the list.
|
||||
In addition, there are the following keybindings:
|
||||
| Key | Action |
|
||||
| --- | ------ |
|
||||
| enter | Open note/journal in your `$EDITOR` |
|
||||
| ctrl-d | Delete the seleted entry |
|
||||
| ctrl-n | Make a new entry |
|
||||
| ctrl-r | Refresh the view |
|
||||
| ctrl-s | Run the synchronization command |
|
||||
| `enter` | Open note/journal/task in your `$EDITOR` |
|
||||
| `ctrl-alt-d` | Delete the seleted entry |
|
||||
| `ctrl-n` | Make a new entry |
|
||||
| `ctrl-r` | Refresh the view |
|
||||
| `ctrl-s` | Run the synchronization command |
|
||||
| `ctrl-x` | Toggle task completion |
|
||||
| `alt-up` | Increase task priority |
|
||||
| `alt-down` | Decrease task priority |
|
||||
| `alt-0` | Default view: Journal, notes, and _open_ tasks |
|
||||
| `alt-1` | Display journal entries |
|
||||
| `alt-2` | Display notes |
|
||||
| `alt-3` | Display all tasks |
|
||||
|
||||
You may also invoke the script with `--help` to see further command-line options.
|
||||
|
||||
Limitations
|
||||
-----------
|
||||
Here is a list of some currently present limitations.
|
||||
|
||||
- Timezone agnostic: Timezone specifications are ignored.
|
||||
- Time agnostic: We use the date portion only of date-time specifications.
|
||||
- No alarms or notifications
|
||||
- No attachments
|
||||
- No recurrences
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
382
fzf-vjour
382
fzf-vjour
@@ -1,382 +0,0 @@
|
||||
#!/bin/sh
|
||||
|
||||
set -eu
|
||||
|
||||
# Read configuration
|
||||
CONFIGFILE="$HOME/.config/fzf-vjour/config.yaml"
|
||||
if [ ! -e "$CONFIGFILE" ]; then
|
||||
echo "Config file '$CONFIGFILE' not found"
|
||||
exit 1
|
||||
fi
|
||||
ROOT=$(yq '.datadir' <"$CONFIGFILE")
|
||||
ROOT=$(eval "echo $ROOT")
|
||||
if [ ! -d "$ROOT" ]; then
|
||||
echo "Root directory not set or wrongly set"
|
||||
exit 1
|
||||
fi
|
||||
SED_COLLECTIONNAMES_TO_LABELS=$(
|
||||
printf "sed "
|
||||
yq '.collections[] | "s|/*" + .name + "/*|:" + .label + "\ |"' <"$CONFIGFILE" |
|
||||
xargs printf "-e \"%s\" "
|
||||
)
|
||||
SED_COLLECTIONLABELS_TO_NAMES=$(
|
||||
printf "sed "
|
||||
yq '.collections[] | "s|\ *" + .label + "\ *|/" + .name + "/|"' <"$CONFIGFILE" |
|
||||
xargs printf "-e \"%s\" "
|
||||
)
|
||||
COLLECTION_LABEL_MAX_LEN=$(yq '[.collections[].label | length] | max' <"$CONFIGFILE")
|
||||
LABLES=$(yq '.collections[].label' <"$CONFIGFILE")
|
||||
SYNC_CMD=$(yq '.sync_cmd' <"$CONFIGFILE")
|
||||
|
||||
__vjournalnew() {
|
||||
python3 -c '
|
||||
import sys
|
||||
from datetime import date, datetime
|
||||
from icalendar.cal import Calendar, Journal
|
||||
|
||||
if not len(sys.argv) == 2:
|
||||
print("Pass uid as first argument!", file=sys.stderr)
|
||||
sys.exit(1)
|
||||
|
||||
UID = sys.argv[1]
|
||||
ical = Calendar()
|
||||
j = Journal()
|
||||
|
||||
isnote = True
|
||||
line = sys.stdin.readline().strip()
|
||||
if line[:4] == "::: ":
|
||||
isnote = False
|
||||
line = sys.stdin.readline().strip()
|
||||
|
||||
if not line[:2] == "# ":
|
||||
print("Error: Summary line is corrupt!", file=sys.stderr)
|
||||
sys.exit(1)
|
||||
summary = line[2:]
|
||||
|
||||
line = sys.stdin.readline().strip()
|
||||
if not line[:2] == "> " and not line == ">":
|
||||
print("Error: Categories line is corrupt!", file=sys.stderr)
|
||||
sys.exit(1)
|
||||
categories = line[2:].split(",")
|
||||
|
||||
line = sys.stdin.readline().strip()
|
||||
if not line == "":
|
||||
print("Error: Missing separating line!", file=sys.stderr)
|
||||
sys.exit(1)
|
||||
|
||||
description = sys.stdin.read()
|
||||
|
||||
# Create ical
|
||||
j["SUMMARY"] = summary
|
||||
j.categories = categories
|
||||
j["DESCRIPTION"] = description
|
||||
j.LAST_MODIFIED = datetime.utcnow()
|
||||
j.DTSTAMP = datetime.utcnow()
|
||||
j["UID"] = UID
|
||||
j["SEQUENCE"] = 1
|
||||
j["STATUS"] = "FINAL"
|
||||
if not isnote:
|
||||
j.DTSTART = date.today()
|
||||
ical.add_component(j)
|
||||
ical["VERSION"] = "2.0"
|
||||
ical["PRODID"] = "vjournew/basic"
|
||||
|
||||
# Print
|
||||
print(ical.to_ical().decode().replace("\r\n", "\n"))' "$@"
|
||||
}
|
||||
__vjournalupdate() {
|
||||
python3 -c '
|
||||
import sys
|
||||
from datetime import datetime
|
||||
from icalendar.cal import Journal
|
||||
|
||||
if not len(sys.argv) == 2:
|
||||
print("Pass ical file as first argument!", file=sys.stderr)
|
||||
sys.exit(1)
|
||||
|
||||
with open(sys.argv[1], "r") as f:
|
||||
try:
|
||||
ical = Journal.from_ical(f.read())
|
||||
except Exception as e:
|
||||
print(f"Failed to read vjournal file: {e}", file=sys.stderr)
|
||||
sys.exit(1)
|
||||
|
||||
jlist = [component for component in ical.walk("VJOURNAL")]
|
||||
if len(jlist) == 0:
|
||||
print("ical file is not a VJOURNAL", file=sys.stderr)
|
||||
sys.exit(1)
|
||||
j = jlist[0]
|
||||
|
||||
line = sys.stdin.readline().strip()
|
||||
if not line[:2] == "# ":
|
||||
print("Error: Summary line is corrupt!", file=sys.stderr)
|
||||
sys.exit(1)
|
||||
summary = line[2:]
|
||||
|
||||
line = sys.stdin.readline().strip()
|
||||
if not line[:2] == "> " and not line == ">":
|
||||
print("Error: Categories line is corrupt!", file=sys.stderr)
|
||||
sys.exit(1)
|
||||
categories = line[2:].split(",")
|
||||
|
||||
line = sys.stdin.readline().strip()
|
||||
if not line == "":
|
||||
print("Error: Missing separating line!", file=sys.stderr)
|
||||
sys.exit(1)
|
||||
|
||||
description = sys.stdin.read()
|
||||
|
||||
# Update ical
|
||||
j["SUMMARY"] = summary
|
||||
j.categories = categories
|
||||
j["DESCRIPTION"] = description
|
||||
j.LAST_MODIFIED = datetime.utcnow()
|
||||
|
||||
# Print
|
||||
print(ical.to_ical().decode().replace("\r\n", "\n"))
|
||||
' "$@"
|
||||
}
|
||||
|
||||
__vjournal2json() {
|
||||
python3 -c '
|
||||
import sys
|
||||
import json
|
||||
from datetime import datetime
|
||||
from zoneinfo import ZoneInfo
|
||||
from icalendar.cal import Journal
|
||||
|
||||
input_data = sys.stdin.read()
|
||||
try:
|
||||
ical = Journal.from_ical(input_data)
|
||||
except Exception as e:
|
||||
print(f"Failed to read vjournal file: {e}", file=sys.stderr)
|
||||
sys.exit(1)
|
||||
|
||||
jlist = [component for component in ical.walk("VJOURNAL")]
|
||||
if len(jlist) == 0:
|
||||
sys.exit(0)
|
||||
|
||||
j = jlist[0]
|
||||
|
||||
local_tz = ZoneInfo("localtime")
|
||||
data = {
|
||||
"summary": j.get("SUMMARY"),
|
||||
"description": j.get("DESCRIPTION"),
|
||||
"categories": j.categories,
|
||||
"class": j.get("CLASS"),
|
||||
"created": str(j.DTSTAMP.astimezone(local_tz)),
|
||||
"last_modified": str(j.LAST_MODIFIED.astimezone(local_tz)),
|
||||
"start": str(
|
||||
j.DTSTART.astimezone(local_tz)
|
||||
if isinstance(j.DTSTART, datetime)
|
||||
else j.DTSTART or ""
|
||||
),
|
||||
}
|
||||
|
||||
print(json.dumps(data))'
|
||||
}
|
||||
# Process each file
|
||||
# This function takes two arguments:
|
||||
#
|
||||
# @param string: Path to ics file
|
||||
# @param string: Maximum length of filenames (for padding purposes)
|
||||
__filepath_to_searchline() {
|
||||
filepath="$1"
|
||||
maxlen="$2"
|
||||
totallen=$((maxlen + ${#ROOT}))
|
||||
filepathpad=$(printf "%-${totallen}s" "$filepath")
|
||||
|
||||
# Color support
|
||||
GREEN=$(printf '\033[1;32m')
|
||||
WHITE=$(printf '\033[1;97m')
|
||||
FAINT=$(printf '\033[2m')
|
||||
OFF=$(printf '\033[m')
|
||||
|
||||
# Parse file
|
||||
summary=""
|
||||
categories=""
|
||||
dtstamp=""
|
||||
dtstart=""
|
||||
while IFS= read -r line; do
|
||||
case "$line" in
|
||||
SUMMARY:*)
|
||||
summary="${line#SUMMARY:}"
|
||||
;;
|
||||
CATEGORIES:*)
|
||||
categories="${line#CATEGORIES:}"
|
||||
;;
|
||||
DTSTAMP:*)
|
||||
dtstamp="${line#DTSTAMP:}"
|
||||
;;
|
||||
DTSTART*:[0-9]*)
|
||||
dtstart=$(echo "$line" | grep -oE '[0-9]{8}')
|
||||
;;
|
||||
esac
|
||||
if [ -n "$summary" ] && [ -n "$categories" ] && [ -n "$dtstamp" ] && [ -n "$dtstart" ]; then
|
||||
break
|
||||
fi
|
||||
done <"$filepath"
|
||||
|
||||
# Parse date
|
||||
if [ -n "$dtstart" ]; then
|
||||
date_target=$(date -d "$dtstart" +%s)
|
||||
date_today=$(date +%s)
|
||||
date_delta=$(((date_target - date_today) / 86400))
|
||||
date_expr=$date_delta
|
||||
if [ "$date_delta" -eq 0 ]; then
|
||||
date_expr="today"
|
||||
elif [ "$date_delta" -eq -1 ]; then
|
||||
date_expr="yesterday"
|
||||
elif [ "$date_delta" -eq 1 ]; then
|
||||
date_expr="tomorrow"
|
||||
elif [ "$date_delta" -lt -1 ] && [ "$date_delta" -ge -7 ]; then
|
||||
date_expr="last $(date -d "$dtstart" +%A)"
|
||||
elif [ "$date_delta" -gt 1 ] && [ "$date_delta" -le 7 ]; then
|
||||
date_expr="next $(date -d "$dtstart" +%A)"
|
||||
else
|
||||
date_expr=$(date -d "$dtstart" +%x)
|
||||
fi
|
||||
date_emoji="📘"
|
||||
else
|
||||
date_emoji="🗒️"
|
||||
date_expr=""
|
||||
fi
|
||||
date_expr=$(printf "%12s" "$date_expr")
|
||||
|
||||
# Print line
|
||||
echo "$dtstamp $filepath $WHITE$date_expr$OFF $date_emoji $GREEN$summary$OFF $FAINT$categories$OFF"
|
||||
}
|
||||
|
||||
__lines() {
|
||||
# Collect all files
|
||||
FILES_TMP=$(mktemp)
|
||||
trap 'rm -f "$FILES_TMP"' EXIT
|
||||
find "$ROOT" -type f -name '*.ics' >"$FILES_TMP"
|
||||
|
||||
# Compute max length of basenames
|
||||
maxlen=0
|
||||
while IFS= read -r file; do
|
||||
name=$(basename "$file")
|
||||
[ ${#name} -gt "$maxlen" ] && maxlen=${#name}
|
||||
done <"$FILES_TMP"
|
||||
|
||||
lines=$(while IFS= read -r file; do
|
||||
__filepath_to_searchline "$file" "$maxlen"
|
||||
done <"$FILES_TMP")
|
||||
|
||||
# Decorate
|
||||
lines=$(echo "$lines" | eval "$SED_COLLECTIONNAMES_TO_LABELS")
|
||||
|
||||
# Sort and cut off irreleant part
|
||||
lines=$(echo "$lines" | sort -g -r | cut -d ':' -f 2-)
|
||||
|
||||
echo "$lines"
|
||||
}
|
||||
|
||||
__filepath_from_selection() {
|
||||
selection=$(echo "$1" | cut -d " " -f 1,2 | eval "$SED_COLLECTIONLABELS_TO_NAMES" | sed "s|^|$ROOT/|")
|
||||
echo "$selection"
|
||||
}
|
||||
|
||||
# Program starts here
|
||||
|
||||
# Command line arguments to be self-contained
|
||||
# Generate preview of file from selection
|
||||
if [ "${1:-}" = "--preview" ]; then
|
||||
vjfile=$(__filepath_from_selection "$2")
|
||||
__vjournal2json <"$vjfile" | jq -r ".description" | batcat --color=always --style=numbers --language=md
|
||||
exit
|
||||
fi
|
||||
# Delete file from selection
|
||||
if [ "${1:-}" = "--delete" ]; then
|
||||
vjfile=$(__filepath_from_selection "$2")
|
||||
rm -v "$vjfile"
|
||||
fi
|
||||
# Generate new entry
|
||||
if [ "${1:-}" = "--new" ]; then
|
||||
label_new=$(echo "$LABLES" | fzf \
|
||||
--margin 20% \
|
||||
--prompt="Select collection> ")
|
||||
uuid_new=$(uuidgen)
|
||||
vjfile_new=$(__filepath_from_selection "$label_new $uuid_new.ics")
|
||||
if [ -f "$vjfile_new" ]; then
|
||||
echo "Bad luck..."
|
||||
return 1
|
||||
fi
|
||||
#
|
||||
TMPFILE="$(mktemp).md"
|
||||
SHAFILE="$TMPFILE.sha"
|
||||
trap 'rm -f "$TMPFILE" "$SHAFILE"' EXIT
|
||||
{
|
||||
echo "::: Keep this line if you want to add a **JOURNAL** entry (associated to today), else we will add a **NOTE**"
|
||||
echo "# <write summary here>"
|
||||
echo "> <comma-separated list of categories>"
|
||||
echo ""
|
||||
} >"$TMPFILE"
|
||||
sha1sum "$TMPFILE" >"$SHAFILE"
|
||||
|
||||
# Open in editor
|
||||
$EDITOR "$TMPFILE" >/dev/tty
|
||||
|
||||
# Update if changes are detected
|
||||
if ! sha1sum -c "$SHAFILE" >/dev/null 2>&1; then
|
||||
vjfile_tmp="$TMPFILE.ics"
|
||||
trap 'rm -f "$vjfile_tmp"' EXIT
|
||||
__vjournalnew "$uuid_new" <"$TMPFILE" >"$vjfile_tmp" && mv "$vjfile_tmp" "$vjfile_new"
|
||||
fi
|
||||
fi
|
||||
if [ "${1:-}" = "--reload" ]; then
|
||||
__lines
|
||||
exit
|
||||
fi
|
||||
|
||||
selection=$(
|
||||
__lines | fzf --ansi \
|
||||
--preview="$0 --preview {}" \
|
||||
--bind="ctrl-d:become($0 --delete {})" \
|
||||
--bind="ctrl-n:become($0 --new)" \
|
||||
--bind="ctrl-s:execute($SYNC_CMD)" \
|
||||
--bind="ctrl-r:reload-sync($0 --reload)"
|
||||
)
|
||||
if [ -z "$selection" ]; then
|
||||
return 0
|
||||
fi
|
||||
|
||||
VJ_FILE=$(__filepath_from_selection "$selection")
|
||||
|
||||
if [ ! -f "$VJ_FILE" ]; then
|
||||
echo "ERROR: File '$VJ_FILE' does not exist!"
|
||||
return 1
|
||||
fi
|
||||
|
||||
# Parse vjournal file and save as json
|
||||
TMPJSON="$(mktemp).json"
|
||||
trap 'rm -f "$TMPJSON"' EXIT
|
||||
__vjournal2json <"$VJ_FILE" >"$TMPJSON"
|
||||
|
||||
# Prepare file to be edited
|
||||
TMPFILE="$(mktemp).md"
|
||||
SHAFILE="$TMPFILE.sha"
|
||||
trap 'rm -f "$TMPFILE" "$SHAFILE"' EXIT
|
||||
SUMMARY=$(jq -r '.summary' "$TMPJSON")
|
||||
CATEGORIES=$(jq -r '.categories | join(",")' "$TMPJSON")
|
||||
{
|
||||
echo "# $SUMMARY"
|
||||
echo "> $CATEGORIES"
|
||||
echo ""
|
||||
jq -r '.description' "$TMPJSON"
|
||||
} >"$TMPFILE"
|
||||
sha1sum "$TMPFILE" >"$SHAFILE"
|
||||
|
||||
# Open in editor
|
||||
$EDITOR "$TMPFILE"
|
||||
|
||||
# Update only if changes are detected
|
||||
if ! sha1sum -c "$SHAFILE" >/dev/null 2>&1; then
|
||||
echo "Uh... chages detected!"
|
||||
vj_file_new="$TMPFILE.ics"
|
||||
trap 'rm -f "$vj_file_new"' EXIT
|
||||
__vjournalupdate "$VJ_FILE" <"$TMPFILE" >"$vj_file_new" && mv "$vj_file_new" "$VJ_FILE"
|
||||
fi
|
||||
|
||||
exec "$0"
|
||||
19
scripts/build.sh
Executable file
19
scripts/build.sh
Executable file
@@ -0,0 +1,19 @@
|
||||
#!/bin/sh
|
||||
|
||||
BOLD="\033[1m"
|
||||
GREEN="\033[0;32m"
|
||||
OFF="\033[m"
|
||||
NAME="fzf-vjour"
|
||||
SRC="./src/main.sh"
|
||||
|
||||
tmpdir=$(mktemp -d)
|
||||
echo "🐔 ${GREEN}Internalize sourced files${OFF}"
|
||||
sed -E 's|\. "([^$].+)"$|cat src/\1|e' "$SRC" >"$tmpdir/1.sh"
|
||||
echo "🥚 ${GREEN}Internalize awk scripts${OFF}"
|
||||
sed -E 's|@@include (.+)$|cat src/\1|e' "$tmpdir/1.sh" >"$tmpdir/2.sh"
|
||||
echo "🐔 ${GREEN}Internalize awk libraries${OFF}"
|
||||
sed -E 's|@include "(.+)"$|cat src/\1|e' "$tmpdir/2.sh" >"$NAME"
|
||||
echo "🥚 ${GREEN}Make executable and cleanup${OFF}"
|
||||
chmod +x "$NAME"
|
||||
rm -rf "$tmpdir"
|
||||
echo "🍳 ${GREEN}Done:${OFF} Sucessfully built ${BOLD}${GREEN}$NAME${OFF}"
|
||||
41
src/awk/altertodo.awk
Normal file
41
src/awk/altertodo.awk
Normal file
@@ -0,0 +1,41 @@
|
||||
# Increase/decrease priority, or toggle completed status
|
||||
#
|
||||
# If `delta` is specified using `-v`, then the priority value is increased by
|
||||
# `delta.` If `delta` is unspecified (or equal to 0), then the completeness
|
||||
# status is toggled.
|
||||
BEGIN {
|
||||
FS=":";
|
||||
zulu = strftime("%Y%m%dT%H%M%SZ", systime(), 1);
|
||||
delta = delta + 0; # cast as integer
|
||||
}
|
||||
/^END:VTODO/ && inside {
|
||||
# Print sequence and last-modified, if not yet printed
|
||||
if (!seq) print "SEQUENCE:1";
|
||||
if (!lm) print "LAST-MODIFIED:" zulu;
|
||||
|
||||
# Print priority
|
||||
prio = prio ? prio + delta : 0 + delta;
|
||||
prio = prio < 0 ? 0 : prio;
|
||||
prio = prio > 9 ? 9 : prio;
|
||||
print "PRIORITY:" prio;
|
||||
|
||||
# Print status (toggle if needed)
|
||||
bit_status = status == "COMPLETED" ? 1 : 0;
|
||||
bit_toggle = delta ? 0 : 1;
|
||||
percent = xor(bit_status, bit_toggle) ? 100 : 0;
|
||||
status = xor(bit_status, bit_toggle) ? "COMPLETED" : "NEEDS-ACTION";
|
||||
print "STATUS:" status
|
||||
print "PERCENT-COMPLETE:" percent
|
||||
|
||||
# print rest
|
||||
inside = "";
|
||||
print $0;
|
||||
next
|
||||
}
|
||||
/^BEGIN:VTODO/ { inside = 1; print; next }
|
||||
/^SEQUENCE/ && inside { seq = 1; print "SEQUENCE:" $2+1; next }
|
||||
/^LAST-MODIFIED/ && inside { lm = 1; print "LAST-MODIFIED:" zulu; next }
|
||||
/^PRIORITY:/ && inside { prio = $2; next }
|
||||
/^STATUS/ && inside { status = $2; next }
|
||||
/^PERCENT-COMPLETE/ && inside { next } # ignore, we take STATUS:COMPLETED as reference
|
||||
{ print }
|
||||
24
src/awk/export.awk
Normal file
24
src/awk/export.awk
Normal file
@@ -0,0 +1,24 @@
|
||||
@include "lib/awk/icalendar.awk"
|
||||
|
||||
BEGIN { FS = "[:;]"; }
|
||||
/^BEGIN:(VJOURNAL|VTODO)/ { type = $2 }
|
||||
/^END:/ && $2 == type { exit }
|
||||
/^(CATEGORIES|DESCRIPTION|SUMMARY|DUE)/ { prop = $1; c[prop] = $0; next; }
|
||||
/^[^ ]/ && prop { prop = ""; next; }
|
||||
/^ / && prop { c[prop] = c[prop] substr($0, 2); next; }
|
||||
END {
|
||||
if (!type)
|
||||
exit
|
||||
# Process content lines, force CATEGORIES and SUMMARY as single-line
|
||||
c["CATEGORIES"] = singleline(getcontent(c["CATEGORIES"]))
|
||||
c["DESCRIPTION"] = getcontent(c["DESCRIPTION"])
|
||||
c["SUMMARY"] = singleline(getcontent(c["SUMMARY"]))
|
||||
c["DUE"] = getcontent(c["DUE"])
|
||||
# Print
|
||||
if (c["DUE"])
|
||||
print "::: <| " substr(c["DUE"], 1, 4) "-" substr(c["DUE"], 5, 2) "-" substr(c["DUE"], 7, 2);
|
||||
print "# " c["SUMMARY"];
|
||||
print "> " c["CATEGORIES"];
|
||||
print "";
|
||||
print c["DESCRIPTION"];
|
||||
}
|
||||
14
src/awk/get.awk
Normal file
14
src/awk/get.awk
Normal file
@@ -0,0 +1,14 @@
|
||||
@include "lib/awk/icalendar.awk"
|
||||
|
||||
# print content of field `field`
|
||||
BEGIN { FS = ":"; regex = "^" field; }
|
||||
/^BEGIN:(VJOURNAL|VTODO)/ { type = $2 }
|
||||
/^END:/ && $2 == type { exit }
|
||||
$0 ~ field { line = $0; next; }
|
||||
/^ / && line { line = line substr($0, 2); next; }
|
||||
/^[^ ]/ && line { exit }
|
||||
END {
|
||||
if (!type) { exit }
|
||||
# Process line
|
||||
print getcontent(line)
|
||||
}
|
||||
206
src/awk/list.awk
Normal file
206
src/awk/list.awk
Normal file
@@ -0,0 +1,206 @@
|
||||
# awk script to generate summary line for iCalendar VJOURNAL and VTODO entries
|
||||
#
|
||||
# See https://datatracker.ietf.org/doc/html/rfc5545 for the RFC 5545 that
|
||||
# describes iCalendar, and its syntax
|
||||
|
||||
@include "lib/awk/icalendar.awk"
|
||||
|
||||
# Generate kind-of-pretty date strings.
|
||||
#
|
||||
# @local variables: ts, ts_y, ts_m, ts_d, delta
|
||||
# @input date: Date in the format YYYYMMDD
|
||||
# @input todaystamp: Today, seconds since epoch
|
||||
# @return: string
|
||||
function formatdate(date, todaystamp, ts, ts_y, ts_m, ts_d, delta)
|
||||
{
|
||||
ts_y = substr(date, 1, 4);
|
||||
ts_m = substr(date, 5, 2);
|
||||
ts_d = substr(date, 7);
|
||||
ts = mktime(ts_y " " ts_m " " ts_d " 00 00 00");
|
||||
delta = (ts - todaystamp) / 86400;
|
||||
if (delta >= 0 && delta < 1) {
|
||||
return " today";
|
||||
}
|
||||
if (delta >= 1 && delta < 2) {
|
||||
return " tomorrow";
|
||||
}
|
||||
if (delta >= 2 && delta < 3) {
|
||||
return " in two days";
|
||||
}
|
||||
if (delta >= 3 && delta < 4) {
|
||||
return " in three days";
|
||||
}
|
||||
if (delta < 0 && delta >= -1) {
|
||||
return " yesterday";
|
||||
}
|
||||
if (delta < -1 && delta >= -2) {
|
||||
return " two days ago";
|
||||
}
|
||||
if (delta < -2 && delta >= -3) {
|
||||
return "three days ago";
|
||||
}
|
||||
return " " substr(date, 1, 4) "-" substr(date, 5, 2) "-" substr(date, 7);
|
||||
}
|
||||
|
||||
BEGIN {
|
||||
# We require the following variables to be set using -v
|
||||
# collection_lables: ;-delimited collection=label strings
|
||||
# flag_open: symbol for open to-dos
|
||||
# flag_completed: symbol for completed to-dos
|
||||
# flag_journal: symbol for journal entries
|
||||
# flag_note: symbol for note entries
|
||||
|
||||
FS = "[:;]";
|
||||
# Collections
|
||||
split(collection_labels, mapping, ";");
|
||||
for (map in mapping)
|
||||
{
|
||||
split(mapping[map], m, "=");
|
||||
collection2label[m[1]] = m[2];
|
||||
}
|
||||
# Colors
|
||||
GREEN = "\033[1;32m";
|
||||
RED = "\033[1;31m";
|
||||
WHITE = "\033[1;97m";
|
||||
CYAN = "\033[1;36m";
|
||||
OFF = "\033[m";
|
||||
|
||||
# For date comparision
|
||||
today = strftime("%Y%m%d");
|
||||
todaystamp = mktime(substr(today, 1, 4) " " substr(today, 5, 2) " " substr(today, 7) " 00 00 00");
|
||||
}
|
||||
|
||||
# Reset variables
|
||||
BEGINFILE {
|
||||
type = "";
|
||||
prop = "";
|
||||
delete c;
|
||||
}
|
||||
|
||||
/^BEGIN:(VJOURNAL|VTODO)/ {
|
||||
type = $2
|
||||
}
|
||||
|
||||
/^END:/ && $2 == type {
|
||||
nextfile
|
||||
}
|
||||
|
||||
/^(CATEGORIES|PRIORITY|STATUS|SUMMARY|COMPLETED|DUE|DTSTART|DURATION|CREATED|DTSTAMP|LAST-MODIFIED)/ {
|
||||
prop = $1;
|
||||
c[prop] = $0;
|
||||
next;
|
||||
}
|
||||
/^[^ ]/ && prop {
|
||||
prop = "";
|
||||
next;
|
||||
}
|
||||
/^ / && prop {
|
||||
c[prop] = c[prop] substr($0, 2);
|
||||
next;
|
||||
}
|
||||
|
||||
ENDFILE {
|
||||
if (!type) {
|
||||
exit
|
||||
}
|
||||
# Construct path, and check for validity
|
||||
depth = split(FILENAME, path, "/");
|
||||
fpath = path[depth-1] "/" path[depth]
|
||||
if (index(fpath, " "))
|
||||
{
|
||||
print 10,
|
||||
"-",
|
||||
type,
|
||||
"-",
|
||||
RED "ERROR: file '" fpath "' contains whitespaces!" OFF
|
||||
exit
|
||||
}
|
||||
# Collection name
|
||||
collection = path[depth-1]
|
||||
collection = collection in collection2label ? collection2label[collection] : collection;
|
||||
|
||||
# Process content lines
|
||||
# strings
|
||||
cat = singleline(unescape(getcontent(c["CATEGORIES"])))
|
||||
sta = singleline(unescape(getcontent(c["STATUS"])))
|
||||
sum = singleline(unescape(getcontent(c["SUMMARY"])))
|
||||
|
||||
# integers
|
||||
pri = unescape(getcontent(c["PRIORITY"]))
|
||||
pri = pri ? pri + 0 : 0
|
||||
|
||||
# dates
|
||||
due = substr(unescape(getcontent(c["DUE"])), 1, 8)
|
||||
dts = substr(unescape(getcontent(c["DTSTART"])), 1, 8)
|
||||
|
||||
# date-times
|
||||
com = unescape(getcontent(c["COMPLETED"]))
|
||||
dur = unescape(getcontent(c["DURATION"]))
|
||||
cre = unescape(getcontent(c["CREATED"]))
|
||||
stp = unescape(getcontent(c["DTSTAMP"]))
|
||||
lmd = unescape(getcontent(c["LAST-MODIFIED"]))
|
||||
|
||||
# Priority field, primarly used for sorting
|
||||
psort = 0;
|
||||
priotext = ""
|
||||
if (pri > 0)
|
||||
{
|
||||
priotext = "❗(" pri ") "
|
||||
psort = 10 - pri
|
||||
}
|
||||
|
||||
# Last modification/creation time stamp, used for sorting
|
||||
# LAST-MODIFIED: Optional field for VTODO and VJOURNAL entries, date-time in
|
||||
# UTC time format
|
||||
# DTSTAMP: mandatory field in VTODO and VJOURNAL, date-time in UTC time
|
||||
# format
|
||||
mod = lmd ? lmd : stp
|
||||
|
||||
# Date field. For VTODO entries, we show the due date, for journal entries,
|
||||
# the associated date.
|
||||
datecolor = CYAN;
|
||||
summarycolor = GREEN;
|
||||
|
||||
if (type == "VTODO")
|
||||
{
|
||||
# Either DUE or DURATION may appear. If DURATION appears, then also DTSTART
|
||||
d = due ? due : (dur ? dts " for " dur : "");
|
||||
if (d && d <= today && sta != "COMPLETED")
|
||||
{
|
||||
datecolor = RED;
|
||||
summarycolor = RED;
|
||||
}
|
||||
} else {
|
||||
d = dts
|
||||
}
|
||||
d = d ? formatdate(d, todaystamp) : " ";
|
||||
|
||||
# flag: - "journal" for VJOURNAL with DTSTART
|
||||
# - "note" for VJOURNAL without DTSTART
|
||||
# - "completed" for VTODO with c["STATUS"] == COMPLETED
|
||||
# - "open" for VTODO with c["STATUS"] != COMPLETED
|
||||
if (type == "VTODO")
|
||||
flag = sta == "COMPLETED" ? flag_completed : flag_open;
|
||||
else
|
||||
flag = dts ? flag_journal : flag_note;
|
||||
|
||||
# summary
|
||||
# c["SUMMARY"]
|
||||
summary = sum ? sum : " "
|
||||
|
||||
# categories
|
||||
categories = cat ? cat : " "
|
||||
|
||||
# filename
|
||||
# FILENAME
|
||||
|
||||
print psort,
|
||||
mod,
|
||||
type,
|
||||
fpath,
|
||||
collection,
|
||||
datecolor d OFF,
|
||||
flag,
|
||||
priotext summarycolor summary OFF,
|
||||
WHITE categories OFF;
|
||||
}
|
||||
68
src/awk/new.awk
Normal file
68
src/awk/new.awk
Normal file
@@ -0,0 +1,68 @@
|
||||
@include "lib/awk/icalendar.awk"
|
||||
|
||||
BEGIN {
|
||||
FS=":";
|
||||
type = "VJOURNAL";
|
||||
zulu = strftime("%Y%m%dT%H%M%SZ", systime(), 1);
|
||||
}
|
||||
desc { desc = desc "\\n" escape($0); next; }
|
||||
{
|
||||
if (substr($0, 1, 6) == "::: |>")
|
||||
{
|
||||
start = substr(zulu, 1, 8);
|
||||
getline;
|
||||
}
|
||||
if (substr($0, 1, 6) == "::: <|")
|
||||
{
|
||||
type = "VTODO"
|
||||
due = substr($0, 8);
|
||||
getline;
|
||||
}
|
||||
summary = substr($0, 1, 2) != "# " ? "" : escape(substr($0, 3));
|
||||
getline;
|
||||
categories = substr($0, 1, 1) != ">" ? "" : escape_but_commas(substr($0, 3));
|
||||
getline; # This line should be empty
|
||||
getline; # First line of description
|
||||
desc = "D" escape($0);
|
||||
next;
|
||||
}
|
||||
END {
|
||||
# Sanitize input
|
||||
if (due) {
|
||||
# Use command line `date` for parsing
|
||||
cmd = "date -d \"" due "\" +\"%Y%m%d\"";
|
||||
cmd | getline res
|
||||
due = res ? res : ""
|
||||
}
|
||||
|
||||
# print ical
|
||||
print "BEGIN:VCALENDAR";
|
||||
print "VERSION:2.0";
|
||||
print "CALSCALE:GREGORIAN";
|
||||
print "PRODID:-//fzf-vjour//awk//EN";
|
||||
print "BEGIN:" type;
|
||||
print "DTSTAMP:" zulu;
|
||||
print "UID:" uid;
|
||||
print "CLASS:PRIVATE";
|
||||
print "CREATED:" zulu;
|
||||
print "SEQUENCE:1";
|
||||
print "LAST-MODIFIED:" zulu;
|
||||
if (type == "VTODO")
|
||||
{
|
||||
print "STATUS:NEEDS-ACTION";
|
||||
print "PERCENT-COMPLETE:0";
|
||||
if (due)
|
||||
print "DUE;VALUE=DATE:" due;
|
||||
}
|
||||
else
|
||||
{
|
||||
print "STATUS:FINAL";
|
||||
if (start)
|
||||
print "DTSTART;VALUE=DATE:" start;
|
||||
}
|
||||
if (summary) print_fold("SUMMARY:", summary);
|
||||
if (categories) print_fold("CATEGORIES:", categories);
|
||||
if (desc) print_fold("DESCRIPTION:", substr(desc, 2));
|
||||
print "END:" type;
|
||||
print "END:VCALENDAR"
|
||||
}
|
||||
52
src/awk/update.awk
Normal file
52
src/awk/update.awk
Normal file
@@ -0,0 +1,52 @@
|
||||
@include "lib/awk/icalendar.awk"
|
||||
|
||||
BEGIN {
|
||||
FS=":";
|
||||
zulu = strftime("%Y%m%dT%H%M%SZ", systime(), 1);
|
||||
}
|
||||
|
||||
ENDFILE {
|
||||
if (NR == FNR)
|
||||
{
|
||||
# Sanitize input
|
||||
if (due) {
|
||||
# Use command line `date` for parsing
|
||||
cmd = "date -d \"" due "\" +\"%Y%m%d\"";
|
||||
cmd | getline res
|
||||
due = res ? res : ""
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
NR == FNR && desc { desc = desc "\\n" escape($0); next; }
|
||||
NR == FNR {
|
||||
if (substr($0, 1, 6) == "::: <|")
|
||||
{
|
||||
due = substr($0, 8);
|
||||
getline;
|
||||
}
|
||||
summary = substr($0, 1, 2) != "# " ? "" : escape(substr($0, 3));
|
||||
getline;
|
||||
categories = substr($0, 1, 1) != ">" ? "" : escape_but_commas(substr($0, 3));
|
||||
getline; # This line should be empty
|
||||
getline; # First line of description
|
||||
desc = "D" escape($0);
|
||||
next;
|
||||
}
|
||||
|
||||
/^BEGIN:(VJOURNAL|VTODO)/ { type = $2; print; next }
|
||||
/^X-ALT-DESC/ && type { next } # drop this alternative description
|
||||
/^ / && type { next } # drop this folded line (the only content with folded lines will be updated)
|
||||
/^(DUE|SUMMARY|CATEGORIES|DESCRIPTION|LAST-MODIFIED)/ && type { next } # skip for now, we will write updated fields at the end
|
||||
/^SEQUENCE/ && type { seq = $2; next } # store sequence number and skip
|
||||
/^END:/ && type == $2 {
|
||||
seq = seq ? seq + 1 : 1;
|
||||
print "SEQUENCE:" seq;
|
||||
print "LAST-MODIFIED:" zulu;
|
||||
if (due) print "DUE;VALUE=DATE:" due;
|
||||
print_fold("SUMMARY:", summary);
|
||||
print_fold("CATEGORIES:", categories);
|
||||
print_fold("DESCRIPTION:", substr(desc, 2));
|
||||
type = "";
|
||||
}
|
||||
{ print }
|
||||
143
src/lib/awk/icalendar.awk
Normal file
143
src/lib/awk/icalendar.awk
Normal file
@@ -0,0 +1,143 @@
|
||||
# Make string single-line
|
||||
#
|
||||
# @input str: String
|
||||
# @return: String without newlines
|
||||
function singleline(str) {
|
||||
gsub("\\n", " ", str)
|
||||
return str
|
||||
}
|
||||
|
||||
# Escape string to be used as content in iCalendar files.
|
||||
#
|
||||
# @input str: String to escape
|
||||
# @return: Escaped string
|
||||
function escape(str)
|
||||
{
|
||||
gsub("\\\\", "\\\\", str)
|
||||
gsub("\\n", "\\n", str)
|
||||
gsub(";", "\\;", str)
|
||||
gsub(",", "\\,", str)
|
||||
return str
|
||||
}
|
||||
|
||||
# Escape string to be used as content in iCalendar files, but don't escape
|
||||
# commas.
|
||||
#
|
||||
# @input str: String to escape
|
||||
# @return: Escaped string
|
||||
function escape_but_commas(str)
|
||||
{
|
||||
gsub("\\\\", "\\\\", str)
|
||||
gsub("\\n", "\\n", str)
|
||||
gsub(";", "\\;", str)
|
||||
return str
|
||||
}
|
||||
|
||||
# Print property with its content and fold according to the iCalendar
|
||||
# specification.
|
||||
#
|
||||
# @local variables: i, s
|
||||
# @input nameparam: Property name with optional parameters
|
||||
# @input content: Escaped content
|
||||
function print_fold(nameparam, content, i, s)
|
||||
{
|
||||
i = 74 - length(nameparam)
|
||||
s = substr(content, 1, i)
|
||||
print nameparam s
|
||||
s = substr(content, i+1, 73)
|
||||
i = i + 73
|
||||
while (s)
|
||||
{
|
||||
print " " s
|
||||
s = substr(content, i+1, 73)
|
||||
i = i + 73
|
||||
}
|
||||
}
|
||||
|
||||
# Unescape string
|
||||
#
|
||||
# @local variables: i, c, c2, res
|
||||
# @input str: String
|
||||
# @return: Unescaped string
|
||||
function unescape(str, i, c, c2, res) {
|
||||
for(i = 1; i <= length(str); i++) {
|
||||
c = substr(str, i, 1)
|
||||
if (c != "\\") {
|
||||
res = res c
|
||||
continue
|
||||
}
|
||||
i++
|
||||
c2 = substr(str, i, 1)
|
||||
if (c2 == "n" || c2 == "N") {
|
||||
res = res "\n"
|
||||
continue
|
||||
}
|
||||
# Alternatively, c2 is "\\" or "," or ";". In each case, append res with
|
||||
# c2. If the strings has been escaped correctly, then the character c2
|
||||
# cannot be anything else. To be fail-safe, simply append res with c2.
|
||||
res = res c2
|
||||
}
|
||||
return res
|
||||
}
|
||||
|
||||
# Isolate parameter part of an iCalendar line.
|
||||
#
|
||||
# @input str: String
|
||||
# @return: Parameter part
|
||||
function getparam(str, i) {
|
||||
i = index(str, ";")
|
||||
if (!i)
|
||||
return ""
|
||||
return substr(str, i + 1, index(str, ":") - i)
|
||||
}
|
||||
|
||||
# Isolate content part of an iCalendar line, and unescape.
|
||||
#
|
||||
# @input str: String
|
||||
# @return: Unescaped content part
|
||||
function getcontent(str) {
|
||||
return unescape(substr(str, index(str, ":") + 1))
|
||||
}
|
||||
|
||||
# Time-zone aware parsing of DTSTART or DTEND entries.
|
||||
#
|
||||
# @local variables: tz
|
||||
# @input dt_param: iCalendar DTSTART or DTEND parameter string
|
||||
# @input dt_content: iCalendar DTSTART or DTEND content string
|
||||
# @return: date or date-time string that can be used in date (1)
|
||||
function parse_dt(dt_param, dt_content, tz, a, i, k) {
|
||||
if (dt_param) {
|
||||
split(dt_param, a, ";")
|
||||
for (i in a) {
|
||||
k = index(a[i], "=")
|
||||
if (substr(a[i], 1, k-1) == "TZID") {
|
||||
tz = "TZ=\"" substr(a[i], k + 1) "\" "
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
# Get date/date-time
|
||||
return length(dt_content) == 8 ?
|
||||
dt dt_content :
|
||||
dt gensub(/^([0-9]{8})T([0-9]{2})([0-9]{2})([0-9]{2})(Z)?$/, "\\1 \\2:\\3:\\4\\5", "g", dt_content)
|
||||
}
|
||||
|
||||
# Map iCalendar duration specification into the format to be used in date (1).
|
||||
#
|
||||
# @local variables: dt, dta, i, n, a, seps
|
||||
# @input duration: iCalendar duration string
|
||||
# @return: relative-date/date-time specification to be used in date (1)
|
||||
function parse_duration(duration, dt, dta, i, n, a, seps) {
|
||||
n = split(duration, a, /[PTWHMSD]/, seps)
|
||||
for (i=2; i<=n; i++) {
|
||||
if(seps[i] == "W") dta["weeks"] = a[i]
|
||||
if(seps[i] == "H") dta["hours"] = a[i]
|
||||
if(seps[i] == "M") dta["minutes"] = a[i]
|
||||
if(seps[i] == "S") dta["seconds"] = a[i]
|
||||
if(seps[i] == "D") dta["days"] = a[i]
|
||||
}
|
||||
dt = a[1] ? a[1] : "+"
|
||||
for (i in dta)
|
||||
dt = dt " " dta[i] " " i
|
||||
return dt
|
||||
}
|
||||
111
src/main.sh
Normal file
111
src/main.sh
Normal file
@@ -0,0 +1,111 @@
|
||||
#!/bin/sh
|
||||
|
||||
set -eu
|
||||
|
||||
# Helper functions
|
||||
. "sh/helper.sh"
|
||||
|
||||
# Read configuration
|
||||
. "sh/config.sh"
|
||||
|
||||
# Load awk scripts
|
||||
. "sh/awkscripts.sh"
|
||||
|
||||
__lines() {
|
||||
find "$ROOT" -type f -name '*.ics' -print0 | xargs -0 -P 0 \
|
||||
awk \
|
||||
-v collection_labels="$COLLECTION_LABELS" \
|
||||
-v flag_open="🔲" \
|
||||
-v flag_completed="✅" \
|
||||
-v flag_journal="📘" \
|
||||
-v flag_note="🗒️" \
|
||||
"$AWK_LIST" |
|
||||
sort -g -r
|
||||
}
|
||||
|
||||
# Program starts here
|
||||
if [ "${1:-}" = "--help" ]; then
|
||||
shift
|
||||
echo "Usage: $0 [--help | --new [FILTER..] | [FILTER..] ]
|
||||
--help Show this help and exit
|
||||
--new Create new entry and do not exit
|
||||
--git-init Activate git usage and exit
|
||||
--git <cmd> Run git command and exit
|
||||
|
||||
[FILTER]
|
||||
You may specify any of these filters. Filters can be negated using the
|
||||
--no-... versions, e.g., --no-tasks. Multiple filters are applied in
|
||||
conjuction. By default, the filter --no-completed is used. Note that
|
||||
--no-completed is not the same as --open, and similarly, --no-open is not the
|
||||
same as --completed.
|
||||
|
||||
--tasks Show tasks only
|
||||
--notes Show notes only
|
||||
--journal Show jounral only
|
||||
--completed Show completed tasks only
|
||||
--open Show open tasks only
|
||||
--filter <query> Specify custom query"
|
||||
exit
|
||||
fi
|
||||
|
||||
# iCalendar routines
|
||||
. "sh/icalendar.sh"
|
||||
|
||||
# Command line arguments: Interal use
|
||||
. "sh/cliinternal.sh"
|
||||
|
||||
# Command line arguments: Interal use
|
||||
. "sh/cli.sh"
|
||||
|
||||
while true; do
|
||||
query=$(stripws "$query")
|
||||
selection=$(
|
||||
__lines | $FZF --ansi \
|
||||
--query="$query " \
|
||||
--no-sort \
|
||||
--no-hscroll \
|
||||
--with-nth=5.. \
|
||||
--print-query \
|
||||
--accept-nth=4 \
|
||||
--preview="$0 --preview {4}" \
|
||||
--expect="ctrl-n,ctrl-alt-d" \
|
||||
--bind="ctrl-r:reload($0 --reload)" \
|
||||
--bind="ctrl-x:reload($0 --reload --toggle-completed {4})" \
|
||||
--bind="alt-up:reload($0 --reload --change-priority '+1' {4})" \
|
||||
--bind="alt-down:reload($0 --reload --change-priority '-1' {4})" \
|
||||
--bind="alt-0:change-query(!✅)" \
|
||||
--bind="alt-1:change-query(📘)" \
|
||||
--bind="alt-2:change-query(🗒️)" \
|
||||
--bind="alt-3:change-query(✅ | 🔲)" \
|
||||
--bind='focus:transform:[ {3} = "VTODO" ] && echo "rebind(ctrl-x)+rebind(alt-up)+rebind(alt-down)" || echo "unbind(ctrl-x)+unbind(alt-up)+unbind(alt-down)"' \
|
||||
--bind="ctrl-s:execute($SYNC_CMD ; printf 'Press <enter> to continue.'; read -r tmp)"
|
||||
)
|
||||
|
||||
# Line 1: query
|
||||
# Line 2: key ("" for enter)
|
||||
# Line 3: relative file path
|
||||
query=$(echo "$selection" | head -n 1)
|
||||
key=$(echo "$selection" | head -n 2 | tail -n 1)
|
||||
fname=$(echo "$selection" | head -n 3 | tail -n 1)
|
||||
if [ "$fname" = "$key" ]; then
|
||||
fname=""
|
||||
fi
|
||||
|
||||
file="$ROOT/$fname"
|
||||
if [ ! -f "$file" ]; then
|
||||
err "File '$file' does not exist!"
|
||||
return 1
|
||||
fi
|
||||
|
||||
case "$key" in
|
||||
"ctrl-n")
|
||||
__new
|
||||
;;
|
||||
"ctrl-alt-d")
|
||||
__delete "$file"
|
||||
;;
|
||||
*)
|
||||
__edit "$file"
|
||||
;;
|
||||
esac
|
||||
done
|
||||
41
src/sh/awkscripts.sh
Normal file
41
src/sh/awkscripts.sh
Normal file
@@ -0,0 +1,41 @@
|
||||
AWK_ALTERTODO=$(
|
||||
cat <<'EOF'
|
||||
@@include awk/altertodo.awk
|
||||
EOF
|
||||
)
|
||||
export AWK_ALTERTODO
|
||||
|
||||
AWK_EXPORT=$(
|
||||
cat <<'EOF'
|
||||
@@include awk/export.awk
|
||||
EOF
|
||||
)
|
||||
export AWK_EXPORT
|
||||
|
||||
AWK_GET=$(
|
||||
cat <<'EOF'
|
||||
@@include awk/get.awk
|
||||
EOF
|
||||
)
|
||||
export AWK_GET
|
||||
|
||||
AWK_LIST=$(
|
||||
cat <<'EOF'
|
||||
@@include awk/list.awk
|
||||
EOF
|
||||
)
|
||||
export AWK_LIST
|
||||
|
||||
AWK_NEW=$(
|
||||
cat <<'EOF'
|
||||
@@include awk/new.awk
|
||||
EOF
|
||||
)
|
||||
export AWK_NEW
|
||||
|
||||
AWK_UPDATE=$(
|
||||
cat <<'EOF'
|
||||
@@include awk/update.awk
|
||||
EOF
|
||||
)
|
||||
export AWK_UPDATE
|
||||
94
src/sh/cli.sh
Normal file
94
src/sh/cli.sh
Normal file
@@ -0,0 +1,94 @@
|
||||
# Git
|
||||
if [ "${1:-}" = "--git-init" ]; then
|
||||
shift
|
||||
if [ -n "${GIT:-}" ]; then
|
||||
err "Git already enabled"
|
||||
return 1
|
||||
fi
|
||||
if ! command -v "git" >/dev/null; then
|
||||
err "Git not installed"
|
||||
return 1
|
||||
fi
|
||||
git -C "$ROOT" init
|
||||
git -C "$ROOT" add -A
|
||||
git -C "$ROOT" commit -m 'Initial commit: Start git tracking'
|
||||
exit
|
||||
fi
|
||||
|
||||
if [ "${1:-}" = "--git" ]; then
|
||||
shift
|
||||
if [ -z "${GIT:-}" ]; then
|
||||
err "Git not supported, run \`$0 --git-init\` first"
|
||||
return 1
|
||||
fi
|
||||
$GIT "$@"
|
||||
exit
|
||||
fi
|
||||
|
||||
# Generate new entry
|
||||
if [ "${1:-}" = "--new" ]; then
|
||||
shift
|
||||
__new
|
||||
fi
|
||||
|
||||
# Build query
|
||||
while [ -n "${1:-}" ]; do
|
||||
case "${1:-}" in
|
||||
"--completed")
|
||||
shift
|
||||
cliquery="${cliquery:-} ✅"
|
||||
;;
|
||||
"--no-completed")
|
||||
shift
|
||||
cliquery="${cliquery:-} !✅"
|
||||
;;
|
||||
"--open")
|
||||
shift
|
||||
cliquery="${cliquery:-} 🔲"
|
||||
;;
|
||||
"--no-open")
|
||||
shift
|
||||
cliquery="${cliquery:-} !🔲"
|
||||
;;
|
||||
"--tasks")
|
||||
shift
|
||||
cliquery="${cliquery:-} ✅ | 🔲"
|
||||
;;
|
||||
"--no-tasks")
|
||||
shift
|
||||
cliquery="${cliquery:-} !✅ !🔲"
|
||||
;;
|
||||
"--notes")
|
||||
shift
|
||||
cliquery="${cliquery:-} 🗒️"
|
||||
;;
|
||||
"--no-notes")
|
||||
shift
|
||||
cliquery="${cliquery:-} !🗒️"
|
||||
;;
|
||||
"--journal")
|
||||
shift
|
||||
cliquery="${cliquery:-} 📘"
|
||||
;;
|
||||
"--no-journal")
|
||||
shift
|
||||
cliquery="${cliquery:-} !📘"
|
||||
;;
|
||||
"--filter")
|
||||
shift
|
||||
cliquery="${cliquery:-} $1"
|
||||
shift
|
||||
;;
|
||||
"--no-filter")
|
||||
shift
|
||||
cliquery="${cliquery:-} !$1"
|
||||
shift
|
||||
;;
|
||||
*)
|
||||
err "Unknown option \"$1\""
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
done
|
||||
query=${cliquery:-!✅}
|
||||
export query
|
||||
0
src/sh/cligit.sh
Normal file
0
src/sh/cligit.sh
Normal file
35
src/sh/cliinternal.sh
Normal file
35
src/sh/cliinternal.sh
Normal file
@@ -0,0 +1,35 @@
|
||||
# Command-line interface for internal use only
|
||||
|
||||
# Generate preview of file from selection
|
||||
if [ "${1:-}" = "--preview" ]; then
|
||||
shift
|
||||
name="$1"
|
||||
shift
|
||||
file="$ROOT/$name"
|
||||
awk -v field="DESCRIPTION" "$AWK_GET" "$file" |
|
||||
$CAT
|
||||
exit
|
||||
fi
|
||||
|
||||
# Reload view
|
||||
if [ "${1:-}" = "--reload" ]; then
|
||||
shift
|
||||
case "${1:-}" in
|
||||
"--toggle-completed")
|
||||
shift
|
||||
fname="$1"
|
||||
shift
|
||||
__toggle_completed "$fname" >/dev/null
|
||||
;;
|
||||
"--change-priority")
|
||||
shift
|
||||
delta=$1
|
||||
shift
|
||||
fname="$1"
|
||||
shift
|
||||
__change_priority "$delta" "$fname" >>/tmp/foo
|
||||
;;
|
||||
esac
|
||||
__lines
|
||||
exit
|
||||
fi
|
||||
45
src/sh/config.sh
Normal file
45
src/sh/config.sh
Normal file
@@ -0,0 +1,45 @@
|
||||
CONFIGFILE="$HOME/.config/fzf-vjour/config"
|
||||
if [ ! -f "$CONFIGFILE" ]; then
|
||||
err "Configuration '$CONFIGFILE' not found."
|
||||
exit 1
|
||||
fi
|
||||
# shellcheck source=/dev/null
|
||||
. "$CONFIGFILE"
|
||||
if [ -z "${ROOT:-}" ] || [ -z "${SYNC_CMD:-}" ] || [ -z "${COLLECTION_LABELS:-}" ]; then
|
||||
err "Configuration is incomplete."
|
||||
exit 1
|
||||
fi
|
||||
export ROOT
|
||||
export SYNC_CMD
|
||||
export COLLECTION_LABELS
|
||||
|
||||
# Tools
|
||||
if command -v "fzf" >/dev/null; then
|
||||
FZF="fzf"
|
||||
else
|
||||
err "Did not find the command-line fuzzy finder fzf."
|
||||
exit 1
|
||||
fi
|
||||
export FZF
|
||||
|
||||
if command -v "uuidgen" >/dev/null; then
|
||||
UUIDGEN="uuidgen"
|
||||
else
|
||||
err "Did not find the uuidgen command."
|
||||
exit 1
|
||||
fi
|
||||
export UUIDGEN
|
||||
|
||||
if command -v "bat" >/dev/null; then
|
||||
CAT="bat"
|
||||
elif command -v "batcat" >/dev/null; then
|
||||
CAT="batcat"
|
||||
fi
|
||||
CAT=${CAT:+$CAT --color=always --style=numbers --language=md}
|
||||
CAT=${CAT:-cat}
|
||||
export CAT
|
||||
|
||||
if command -v "git" >/dev/null && [ -d "$ROOT/.git" ]; then
|
||||
GIT="git -C $ROOT"
|
||||
fi
|
||||
export GIT
|
||||
9
src/sh/helper.sh
Normal file
9
src/sh/helper.sh
Normal file
@@ -0,0 +1,9 @@
|
||||
# Print error message
|
||||
err() {
|
||||
echo "❌ $1" >/dev/tty
|
||||
}
|
||||
|
||||
# Strip whitespaces from argument
|
||||
stripws() {
|
||||
echo "$@" | sed "s/^ *//" | sed "s/ *$//"
|
||||
}
|
||||
128
src/sh/icalendar.sh
Normal file
128
src/sh/icalendar.sh
Normal file
@@ -0,0 +1,128 @@
|
||||
# Interface to modify iCalendar files
|
||||
|
||||
# Toggle completed status of VTODO
|
||||
#
|
||||
# @input $1: Relative path to iCalendar file
|
||||
__toggle_completed() {
|
||||
fname="$1"
|
||||
shift
|
||||
file="$ROOT/$fname"
|
||||
tmpfile=$(mktemp)
|
||||
awk "$AWK_ALTERTODO" "$file" >"$tmpfile"
|
||||
mv "$tmpfile" "$file"
|
||||
if [ -n "${GIT:-}" ]; then
|
||||
$GIT add "$file"
|
||||
$GIT commit -q -m "Completed toggle" -- "$file"
|
||||
fi
|
||||
}
|
||||
|
||||
# Change priority of VTODO entry
|
||||
#
|
||||
# @input $1: Delta, can be any integer
|
||||
# @input $2: Relative path to iCalendar file
|
||||
__change_priority() {
|
||||
delta=$1
|
||||
shift
|
||||
fname="$1"
|
||||
shift
|
||||
echo "call to __change_priority with delta=$delta and fname=$fname" >>/tmp/foo
|
||||
file="$ROOT/$fname"
|
||||
tmpfile=$(mktemp)
|
||||
echo " tmpfile=$tmpfile" >>/tmp/foo
|
||||
awk -v delta="$delta" "$AWK_ALTERTODO" "$file" >"$tmpfile"
|
||||
echo " lines=$(wc -l tmpfile)" >>/tmp/foo
|
||||
mv "$tmpfile" "$file"
|
||||
if [ -n "${GIT:-}" ]; then
|
||||
$GIT add "$file"
|
||||
$GIT commit -q -m "Priority changed by $delta" -- "$file"
|
||||
fi
|
||||
}
|
||||
|
||||
# Edit file
|
||||
#
|
||||
# @input $1: File path
|
||||
__edit() {
|
||||
file="$1"
|
||||
shift
|
||||
filetmp=$(mktemp --suffix='.md')
|
||||
awk "$AWK_EXPORT" "$file" >"$filetmp"
|
||||
checksum=$(cksum "$filetmp")
|
||||
|
||||
# Open in editor
|
||||
$EDITOR "$filetmp" >/dev/tty
|
||||
|
||||
# Update only if changes are detected
|
||||
if [ "$checksum" != "$(cksum "$filetmp")" ]; then
|
||||
file_new="$filetmp.ics"
|
||||
awk "$AWK_UPDATE" "$filetmp" "$file" >"$file_new"
|
||||
mv "$file_new" "$file"
|
||||
if [ -n "${GIT:-}" ]; then
|
||||
$GIT add "$file"
|
||||
$GIT commit -q -m "File modified" -- "$file"
|
||||
fi
|
||||
fi
|
||||
rm "$filetmp"
|
||||
}
|
||||
|
||||
# Delete file
|
||||
#
|
||||
# @input $1: File path
|
||||
__delete() {
|
||||
file="$1"
|
||||
shift
|
||||
summary=$(awk -v field="SUMMARY" "$AWK_GET" "$file")
|
||||
while true; do
|
||||
printf "Do you want to delete the entry with the title \"%s\"? (yes/no): " "$summary" >/dev/tty
|
||||
read -r yn
|
||||
case $yn in
|
||||
"yes")
|
||||
rm -v "$file"
|
||||
if [ -n "${GIT:-}" ]; then
|
||||
$GIT add "$file"
|
||||
$GIT commit -q -m "File deleted" -- "$file"
|
||||
fi
|
||||
break
|
||||
;;
|
||||
"no")
|
||||
break
|
||||
;;
|
||||
*)
|
||||
echo "Please answer \"yes\" or \"no\"." >/dev/tty
|
||||
;;
|
||||
esac
|
||||
done
|
||||
}
|
||||
|
||||
# Add file
|
||||
__new() {
|
||||
collection=$(printf "%s" "$COLLECTION_LABELS" | tr ';' '\n' | $FZF --delimiter='=' --with-nth=2 --accept-nth=1)
|
||||
file=""
|
||||
while [ -f "$file" ] || [ -z "$file" ]; do
|
||||
uuid=$($UUIDGEN)
|
||||
file="$ROOT/$collection/$uuid.ics"
|
||||
done
|
||||
tmpmd=$(mktemp --suffix='.md')
|
||||
{
|
||||
echo "::: |> <!-- keep this line to associate the entry to _today_ -->"
|
||||
echo "::: <| <!-- specify the due date for to-dos, can be empty, a date string, or even \"next Sunday\" -->"
|
||||
echo "# <!-- write summary here -->"
|
||||
echo "> <!-- comma-separated list of categories -->"
|
||||
echo ""
|
||||
} >"$tmpmd"
|
||||
checksum=$(cksum "$tmpmd")
|
||||
|
||||
# Open in editor
|
||||
$EDITOR "$tmpmd" >/dev/tty
|
||||
|
||||
# Update if changes are detected
|
||||
if [ "$checksum" != "$(cksum "$tmpmd")" ]; then
|
||||
tmpfile="$tmpmd.ics"
|
||||
awk -v uid="$uuid" "$AWK_NEW" "$tmpmd" >"$tmpfile"
|
||||
mv "$tmpfile" "$file"
|
||||
if [ -n "${GIT:-}" ]; then
|
||||
$GIT add "$file"
|
||||
$GIT commit -q -m "File added" -- "$file"
|
||||
fi
|
||||
fi
|
||||
rm "$tmpmd"
|
||||
}
|
||||
Reference in New Issue
Block a user