3 # bash-notes © 2023 by danix is licensed under CC BY-NC 4.0.
4 # To view a copy of this license, visit http://creativecommons.org/licenses/by-nc/4.0/
6 # to debug the script run it like:
7 # DEBUG=true notes.sh ...
8 # and check /tmp/debug_bash-notes.log
9 if [[ $DEBUG == true
]]; then
10 exec 5> /tmp
/debug_bash-notes.log
17 BASENAME
=$
( basename "$0" )
21 DBVERSION
=${VERSION}_
${NOW}
26 EDITOR
=${EDITOR:-/usr/bin/vim}
27 TERMINAL
=${TERMINAL:-/usr/bin/alacritty}
28 # add options for your terminal. Remember to add the last option to execute
29 # your editor program, otherwise the script will fail.
30 # see example in the addnote function
31 TERM_OPTS
="--class notes --title notes -e "
32 # Setting PAGER here overrides whatever is set in your default shell
33 # comment this option to use your default pager if set in your shell.
34 PAGER
=${PAGER:-/usr/bin/more}
36 # set this to true to have output in plain text
37 # or use the -p option on the command line before every other option
39 # base directory for program files
40 BASEDIR
=${BASEDIR:-~/.local/share/bash-notes}
41 # notes database in json format
43 # directory containing the actual notes
44 NOTESDIR
=${BASEDIR}/notes
46 } # end set_defaults, do not change this line.
50 # Do not edit below this point
51 RCFILE
=${RCFILE:-~/.config/bash-notes.rc}
54 if [ ! -x "$JQ" ]; then
55 echo "jq not found in your PATH"
56 echo "install jq to continue"
60 # IMPORT USER DEFINED OPTIONS IF ANY
61 if [[ -f $RCFILE ]]; then
62 # shellcheck disable=SC1090
66 # We prevent the program from running more than one instance:
67 PIDFILE
=/var
/tmp
/$
(basename "$0" .sh
).pid
69 # Make sure the PID file is removed when we kill the process
70 trap 'rm -f $PIDFILE; exit 1' TERM INT
72 if [[ -r $PIDFILE ]]; then
73 # PIDFILE exists, so I guess there's already an instance running
74 # let's kill it and run again
75 # shellcheck disable=SC2046,SC2086
76 kill -s 15 $
(cat $PIDFILE) > /dev
/null
2>&1
77 # should already be deleted by trap, but just to be sure
82 echo $PID > "$PIDFILE"
84 # Export config to file
85 function export_config
() {
86 if [ -r ${RCFILE} ]; then
87 echo "Backing up current '${RCFILE}'...."
88 mv -f ${RCFILE} ${RCFILE}.$
(date +%Y
%m
%d_
%H
%M
)
90 echo "Writing '${RCFILE}'...."
91 sed -n '/^set_defaults() {/,/^} # end set_defaults, do not change this line./p' $0 \
92 |
grep -v set_defaults \
93 |
sed -e 's/^\([^=]*\)=\${\1:-\([^}]*\)}/\1=\2/' \
95 if [ -r ${RCFILE} ]; then
96 echo "Taking no further action."
99 echo "Could not write '${RCFILE}'...!"
104 # we should expand on this function to add a sample note and explain a little bit
105 # how the program works.
106 function firstrun
() {
107 [ -f $RCFILE ] && RC
=$RCFILE || RC
="none"
110 echo "${BASENAME} configuration:
112 base directory: ${BASEDIR}/
113 notes archive: ${NOTESDIR}/
114 notes database: ${DB}
116 text editor: ${EDITOR}
117 terminal: ${TERMINAL}
121 echo "Now I'll create the needed files and directories."
122 read -r -p "Do you wish to continue? (y/N) " ANSWER
126 cat << __EOL__ > ${DB}
129 "version": "${VERSION}",
130 "dbversion": "${DBVERSION}"
135 echo; echo "All done, you can now write your first note."
138 echo "No changes made. Exiting"
144 # check for notes dir existance and create it in case it doesn't exists
145 if [[ ! -d $NOTESDIR ]]; then
146 # we don't have a directory. FIRST RUN?
149 # check if input is a number, returns false or the number itself
150 function check_noteID
() {
162 function helptext
() {
164 echo " $0 [PARAMS] [note ID]..."
166 echo "${BASENAME} parameters are:"
167 echo -e " -h | --help\t\t\t: This help text"
168 echo -e " -p | --plain\t\t\t: Output is in plain text"
169 echo -e "\t\t\t\t (without this option the output is formatted)"
170 echo -e "\t\t\t\t (this option must precede all others)"
171 echo -e " -l | --list\t\t\t: List existing notes"
172 echo -e " -a | --add=[\"<title>\"]\t: Add new note"
173 echo -e " -e | --edit=[<note>]\t\t: Edit note"
174 echo -e " -d | --delete=[<note> | all] : Delete single note or all notes at once"
175 echo -e " -s | --show=[<note>]\t\t: Display note using your favourite PAGER"
176 echo -e " -r | --restore=[<dir>]\t: Restore a previous backup from dir"
177 echo -e " -v | --version\t\t: Print version"
178 echo -e " --userconf\t\t\t: Export User config file"
179 echo -e " --backup [<dest>]\t\t: Backup your data in your destination folder"
181 echo -e "if a non option is passed and is a valid note ID, the note will be displayed."
184 function configtext
() {
186 ${BASENAME} configuration is:
188 base directory: ${BASEDIR}/
189 notes archive: ${NOTESDIR}/
190 notes database: ${DB}
192 debug file: /tmp/debug_bash-note.log
194 text editor: ${EDITOR}
195 terminal: ${TERMINAL}
203 # remove eventually existing temp DB file
204 if [[ -f $TMPDB ]]; then
209 echo "adding new note - \"$NOTETITLE\""
210 # shellcheck disable=SC2086
211 LASTID
=$
($JQ '.notes[-1].id // 0 | tonumber' $DB)
212 # [ "" == $LASTID ] && LASTID=0
213 NOTEID
=$
(( LASTID
+ 1 ))
214 # shellcheck disable=SC2086
215 touch ${NOTESDIR}/${NOW}
216 # shellcheck disable=SC2016
217 $JQ --arg i
"$NOTEID" --arg t
"$NOTETITLE" --arg f
"$NOW" '.notes += [{"id": $i, "title": $t, "file": $f}]' "$DB" > $TMPDB
218 # shellcheck disable=SC2086
220 # example for alacritty:
221 # alacritty --class notes --title notes -e /usr/bin/vim ...
222 # shellcheck disable=SC2086,SC2091
223 $
(${TERMINAL} ${TERM_OPTS} ${EDITOR} ${NOTESDIR}/${NOW})
225 function backup_data
() {
227 echo "backing up data in $BACKUPDIR"
230 if [ -d $BACKUPDIR ]; then
231 if [ $
(/bin
/ls -A $BACKUPDIR) ]; then
232 echo "$BACKUPDIR is not empty. Cannot continue"
235 echo "$BACKUPDIR is ok. Continuing!"
238 # BACKUPDIR doesn't exists
239 echo "$BACKUPDIR doesn't exists"
240 read -r -p "Do you want me to create it for you? (y/N) " ANSWER
246 echo "No changes made. Exiting"
251 # ok, we have a backup directory
252 if [ -r $RCFILE ]; then
253 BCKUP_COMM
=$
(rsync
-avz --progress ${RCFILE}* ${BASEDIR}/* ${BACKUPDIR})
255 BCKUP_COMM
=$
(rsync
-avz --progress ${BASEDIR}/* ${BACKUPDIR})
258 if [ "$BCKUP_COMM" ]; then
259 echo -e "All files backed up."
260 echo -e "BACKUP directory:\t$BACKUPDIR"
261 tree
$BACKUPDIR |
$PAGER
262 echo; echo "BACKUP COMPLETED"
266 function backup_restore
() {
268 echo "restoring backup from $BACKUPDIR"
269 echo "This will overwrite all your notes and configurations with the backup."
270 read -r -p "Do you want to continue? (y/N) " ANSWER
274 BACKUPRC
=$
(basename $RCFILE)
275 if [ -r ${BACKUPDIR}/${BACKUPRC} ]; then
276 if [ -r ${RCFILE} ]; then
277 echo "Backing up current '${RCFILE}'...."
278 mv -f ${RCFILE} ${RCFILE}.$
(date +%Y
%m
%d_
%H
%M
)
280 cp --verbose ${BACKUPDIR}/${BACKUPRC} $RCFILE
282 # restoring notes directory
283 if [ -d $BACKUPDIR/notes
]; then
284 if [ $
(/bin
/ls -A $NOTESDIR) ]; then
285 rm --verbose $NOTESDIR/*
287 cp -r --verbose $BACKUPDIR/notes
$BASEDIR
290 BACKUPDB
=$
(basename $DB)
291 if [ -f ${BACKUPDIR}/${BACKUPDB} ]; then
292 if [ -r ${DB} ]; then
293 echo "Backing up current '${DB}'...."
294 mv -f ${DB} ${DB}.$
(date +%Y
%m
%d_
%H
%M
)
296 cp --verbose ${BACKUPDIR}/${BACKUPDB} $DB
300 echo "No changes made. Exiting"
306 function editnote
() {
308 # shellcheck disable=SC2155
309 local OK
=$
(check_noteID
"$NOTE")
311 echo "invalid note \"$NOTE\""
312 echo "Use the note ID that you can fetch after listing your notes"
316 # shellcheck disable=SC2016,SC2086
317 TITLE
=$
($JQ --arg i
$OK '.notes[] | select(.id == $i) | .title' $DB)
318 # shellcheck disable=SC2016,SC2086
319 FILE
=$
($JQ -r --arg i
$OK '.notes[] | select(.id == $i) | .file' $DB)
320 if [ "$TITLE" ]; then
321 echo "editing note $TITLE"
322 # shellcheck disable=SC2086,SC2091
323 $
(${TERMINAL} ${TERM_OPTS} ${EDITOR} ${NOTESDIR}/${FILE})
325 echo "note not found"
329 function listnotes
() {
330 # [ $PLAIN == true ] && echo "output is plain text" || echo "output is colored"
331 if [[ $
(ls -A "$NOTESDIR") ]]; then
332 if [ $PLAIN == false
]; then
333 echo "listing all notes"
336 [ $PLAIN == false
] && echo "[ID] [TITLE] [CREATED]"
337 for i
in "${NOTESDIR}"/*; do
338 # shellcheck disable=SC2155
339 local fname
=$
(basename $i)
340 DATE
=$
(date -d @
${fname} +"%d/%m/%Y %R %z%Z")
341 # shellcheck disable=SC2016,SC2086
342 TITLE
=$
($JQ -r --arg z $
(basename $i) '.notes[] | select(.file == $z) | .title' $DB)
343 # shellcheck disable=SC2016,SC2086
344 ID
=$
($JQ -r --arg z $
(basename $i) '.notes[] | select(.file == $z) | .id' $DB)
345 [ $PLAIN == false
] && echo "[${ID}] ${TITLE} ${DATE}" || echo "${ID} - ${TITLE} - ${DATE}"
348 echo "no notes yet. You can add your first one with: ${BASENAME} -a \"your note title\""
352 # remove eventually existing temp DB file
353 if [[ -f $TMPDB ]]; then
358 if [ "all" == "$NOTE" ]; then
359 echo "You're going to delete all notes."
360 read -r -p "Do you wish to continue? (y/N) " ANSWER
363 # shellcheck disable=SC2086
364 $JQ 'del(.notes[])' $DB > $TMPDB
365 # shellcheck disable=SC2086
367 # shellcheck disable=SC2086
369 echo "Deleted all notes"
372 echo "Aborting, no notes were deleted."
377 # shellcheck disable=SC2155
378 local OK
=$
(check_noteID
"$NOTE")
380 echo "invalid note \"$NOTE\""
381 echo "Use the note ID that you can fetch after listing your notes"
386 # shellcheck disable=SC2016,SC2086
387 TITLE
=$
($JQ --arg i
$OK '.notes[] | select(.id == $i) | .title' $DB)
388 # shellcheck disable=SC2016,SC2086
389 FILE
=$
($JQ -r --arg i
$OK '.notes[] | select(.id == $i) | .file' $DB)
390 if [ "$TITLE" ]; then
391 # shellcheck disable=SC2016,SC2086
392 $JQ -r --arg i
$OK 'del(.notes[] | select(.id == $i))' $DB > $TMPDB
393 # shellcheck disable=SC2086
396 echo "Deleted note $TITLE"
400 echo "note not found"
406 function shownote
() {
409 # shellcheck disable=SC2155
410 local OK
=$
(check_noteID
"$NOTE")
412 echo "invalid note \"$NOTE\""
413 echo "Use the note ID that you can fetch after listing your notes"
417 FILE
=$
($JQ -r --arg i
$OK '.notes[] | select(.id == $i) | .file' $DB)
420 $PAGER ${NOTESDIR}/${FILE}
423 # shellcheck disable=SC2006
424 GOPT
=$
(getopt
-o hvplr
::a
::e
::d
::s
:: --long help,version
,list
,plain
,userconf
,restore
::,backup
::,add
::,edit
::,delete
::,show
:: -n 'bash-notes' -- "$@")
426 # shellcheck disable=SC2181
427 if [ $?
!= 0 ] ; then helptext
>&2 ; exit 1 ; fi
429 # Note the quotes around `$GOPT': they are essential!
440 echo $BASENAME v
${VERSION}
454 read -r -p "Title: " TITLE
467 read -r -p "Note ID: " NOTE
480 read -r -p "Note ID: " NOTE
493 read -r -p "Note ID: " NOTE
506 read -r -p "Backup Dir: " RDIR
518 # shellcheck disable=SC2317
519 echo "config exported to \"$RCFILE\""
520 # shellcheck disable=SC2317
526 read -r -p "Backup Dir: " BDIR
547 if [ $
(check_noteID
$arg) ]; then