From: danix Date: Wed, 29 Mar 2023 09:19:55 +0000 (+0200) Subject: Separated script into multiple files for easier management. Added Makefile X-Git-Tag: v0.3~4 X-Git-Url: https://git.danix.xyz/?p=bash-notes.git;a=commitdiff_plain;h=fb71118327216a21f6732161dc3721496a16370d Separated script into multiple files for easier management. Added Makefile --- diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..0875513 --- /dev/null +++ b/Makefile @@ -0,0 +1,5 @@ +all: notes.sh + +notes.sh: SOURCE/head.sh SOURCE/CORE/helpers.sh SOURCE/CORE/core-* SOURCE/main.sh + cat $^ > "$@" || (rm -f "$@"; exit 1) + chmod 755 "$@" diff --git a/SOURCE/CORE/core-add.sh b/SOURCE/CORE/core-add.sh new file mode 100644 index 0000000..aa9d451 --- /dev/null +++ b/SOURCE/CORE/core-add.sh @@ -0,0 +1,23 @@ +function addnote() { + # remove eventually existing temp DB file + if [[ -f $TMPDB ]]; then + rm $TMPDB + fi + + NOTETITLE="$1" + echo "adding new note - \"$NOTETITLE\"" + # shellcheck disable=SC2086 + LASTID=$($JQ '.notes[-1].id // 0 | tonumber' $DB) + # [ "" == $LASTID ] && LASTID=0 + NOTEID=$(( LASTID + 1 )) + # shellcheck disable=SC2086 + touch ${NOTESDIR}/${NOW} + # shellcheck disable=SC2016 + $JQ --arg i "$NOTEID" --arg t "$NOTETITLE" --arg f "$NOW" '.notes += [{"id": $i, "title": $t, "file": $f}]' "$DB" > $TMPDB + # shellcheck disable=SC2086 + mv $TMPDB $DB + # example for alacritty: + # alacritty --class notes --title notes -e /usr/bin/vim ... + # shellcheck disable=SC2086,SC2091 + $(${TERMINAL} ${TERM_OPTS} ${EDITOR} ${NOTESDIR}/${NOW}) +} diff --git a/SOURCE/CORE/core-edit.sh b/SOURCE/CORE/core-edit.sh new file mode 100644 index 0000000..c42e63d --- /dev/null +++ b/SOURCE/CORE/core-edit.sh @@ -0,0 +1,23 @@ +function editnote() { + NOTE=$1 + # shellcheck disable=SC2155 + local OK=$(check_noteID "$NOTE") + if [ ! "$OK" ]; then + echo "invalid note \"$NOTE\"" + echo "Use the note ID that you can fetch after listing your notes" + exit 1 + fi + + # shellcheck disable=SC2016,SC2086 + TITLE=$($JQ --arg i $OK '.notes[] | select(.id == $i) | .title' $DB) + # shellcheck disable=SC2016,SC2086 + FILE=$($JQ -r --arg i $OK '.notes[] | select(.id == $i) | .file' $DB) + if [ "$TITLE" ]; then + echo "editing note $TITLE" + # shellcheck disable=SC2086,SC2091 + $(${TERMINAL} ${TERM_OPTS} ${EDITOR} ${NOTESDIR}/${FILE}) + else + echo "note not found" + exit 1 + fi +} diff --git a/SOURCE/CORE/core-list.sh b/SOURCE/CORE/core-list.sh new file mode 100644 index 0000000..0580df3 --- /dev/null +++ b/SOURCE/CORE/core-list.sh @@ -0,0 +1,22 @@ +function listnotes() { + # [ $PLAIN == true ] && echo "output is plain text" || echo "output is colored" + if [[ $(ls -A "$NOTESDIR") ]]; then + if [ $PLAIN == false ]; then + echo "listing all notes" + echo "" + fi + [ $PLAIN == false ] && echo "[ID] [TITLE] [CREATED]" + for i in "${NOTESDIR}"/*; do + # shellcheck disable=SC2155 + local fname=$(basename $i) + DATE=$(date -d @${fname} +"%d/%m/%Y %R %z%Z") + # shellcheck disable=SC2016,SC2086 + TITLE=$($JQ -r --arg z $(basename $i) '.notes[] | select(.file == $z) | .title' $DB) + # shellcheck disable=SC2016,SC2086 + ID=$($JQ -r --arg z $(basename $i) '.notes[] | select(.file == $z) | .id' $DB) + [ $PLAIN == false ] && echo "[${ID}] ${TITLE} ${DATE}" || echo "${ID} - ${TITLE} - ${DATE}" + done + else + echo "no notes yet. You can add your first one with: ${BASENAME} -a \"your note title\"" + fi +} diff --git a/SOURCE/CORE/core-remove.sh b/SOURCE/CORE/core-remove.sh new file mode 100644 index 0000000..5776bbc --- /dev/null +++ b/SOURCE/CORE/core-remove.sh @@ -0,0 +1,51 @@ +function rmnote() { + # remove eventually existing temp DB file + if [[ -f $TMPDB ]]; then + rm $TMPDB + fi + + NOTE=$1 + if [ "all" == "$NOTE" ]; then + echo "You're going to delete all notes." + read -r -p "Do you wish to continue? (y/N) " ANSWER + case $ANSWER in + y|Y ) + # shellcheck disable=SC2086 + $JQ 'del(.notes[])' $DB > $TMPDB + # shellcheck disable=SC2086 + mv $TMPDB $DB + # shellcheck disable=SC2086 + rm $NOTESDIR/* + echo "Deleted all notes" + ;; + * ) + echo "Aborting, no notes were deleted." + exit 1 + ;; + esac + else + # shellcheck disable=SC2155 + local OK=$(check_noteID "$NOTE") + if [ ! "$OK" ]; then + echo "invalid note \"$NOTE\"" + echo "Use the note ID that you can fetch after listing your notes" + exit 1 + fi + + # shellcheck disable=SC2016,SC2086 + TITLE=$($JQ --arg i $OK '.notes[] | select(.id == $i) | .title' $DB) + # shellcheck disable=SC2016,SC2086 + FILE=$($JQ -r --arg i $OK '.notes[] | select(.id == $i) | .file' $DB) + if [ "$TITLE" ]; then + # shellcheck disable=SC2016,SC2086 + $JQ -r --arg i $OK 'del(.notes[] | select(.id == $i))' $DB > $TMPDB + # shellcheck disable=SC2086 + mv $TMPDB $DB + rm $NOTESDIR/$FILE + echo "Deleted note $TITLE" + else + echo "note not found" + exit 1 + fi + fi +} diff --git a/SOURCE/CORE/core-show.sh b/SOURCE/CORE/core-show.sh new file mode 100644 index 0000000..1a04c82 --- /dev/null +++ b/SOURCE/CORE/core-show.sh @@ -0,0 +1,17 @@ +function shownote() { + NOTE=$1 + + # shellcheck disable=SC2155 + local OK=$(check_noteID "$NOTE") + if [ ! "$OK" ]; then + echo "invalid note \"$NOTE\"" + echo "Use the note ID that you can fetch after listing your notes" + exit 1 + fi + + FILE=$($JQ -r --arg i $OK '.notes[] | select(.id == $i) | .file' $DB) + + if [ "$FILE" ]; then + $PAGER ${NOTESDIR}/${FILE} + fi +} diff --git a/SOURCE/CORE/helpers.sh b/SOURCE/CORE/helpers.sh new file mode 100644 index 0000000..a8f0981 --- /dev/null +++ b/SOURCE/CORE/helpers.sh @@ -0,0 +1,46 @@ +# check if input is a number, returns false or the number itself +function check_noteID() { + IN=$1 + case $IN in + ''|*[!0-9]*) + return 1 + ;; + *) + echo "$IN" + ;; + esac +} + +function helptext() { + echo "Usage:" + echo " $0 [PARAMS] ..." + echo "" + cat << __NOWCONF__ +${BASENAME} configuration is: + +base directory: ${BASEDIR}/ +notes archive: ${NOTESDIR}/ +notes database: ${DB} +rc file: $RCFILE +debug file: /tmp/debug_bash-note.log + +text editor: ${EDITOR} +terminal: ${TERMINAL} +jq executable: ${JQ} +__NOWCONF__ + + echo "" + echo "${BASENAME} parameters are:" + echo " -h | --help : This help text" + echo " -p | --plain : Output is in plain text" + echo " (without this option the output is formatted)" + echo " (this option must precede all others)" + echo " -l | --list : List existing notes" + echo " -a | --add [\"\"] : Add new note" + echo " -e | --edit [<note>] : Edit note" + echo " -d | --delete [<note> | all] : Delete single note or all notes at once" + echo " -s | --show [<note>] : Display note using your favourite PAGER" + echo " -v | --version : Print version" + echo " --userconf : Export User config file" + echo "" +} diff --git a/SOURCE/head.sh b/SOURCE/head.sh new file mode 100644 index 0000000..d68d171 --- /dev/null +++ b/SOURCE/head.sh @@ -0,0 +1,147 @@ +#! /bin/bash + +# bash-notes © 2023 by danix is licensed under CC BY-NC 4.0. +# To view a copy of this license, visit http://creativecommons.org/licenses/by-nc/4.0/ + +# to debug the script run it like: +# DEBUG=true notes.sh ... +# and check /tmp/debug_bash-notes.log +if [[ $DEBUG == true ]]; then + exec 5> /tmp/debug_bash-notes.log + BASH_XTRACEFD="5" + PS4='$LINENO: ' + set -x +fi + +PID=$$ +BASENAME=$( basename "$0" ) +NOW=$(date +%s) + +VERSION="0.3" +DBVERSION=${VERSION}_${NOW} + +set_defaults() { +# Binaries to use +JQ=${JQ:-/usr/bin/jq} +EDITOR=${EDITOR:-/usr/bin/vim} +TERMINAL=${TERMINAL:-/usr/bin/alacritty} +# add options for your terminal. Remember to add the last option to execute +# your editor program, otherwise the script will fail. +# see example in the addnote function +TERM_OPTS="--class notes --title notes -e " +# Setting PAGER here overrides whatever is set in your default shell +# comment this option to use your default pager if set in your shell. +PAGER=${PAGER:-/usr/bin/more} + +# set this to true to have output in plain text +# or use the -p option on the command line before every other option +PLAIN=false +# base directory for program files +BASEDIR=${BASEDIR:-~/.local/share/bash-notes} +# notes database in json format +DB=${BASEDIR}/db.json +# directory containing the actual notes +NOTESDIR=${BASEDIR}/notes + +} # end set_defaults, do not change this line. + +set_defaults + +# Do not edit below this point +RCFILE=${RCFILE:-~/.config/bash-notes.rc} +TMPDB=/tmp/db.json + +if [ ! -x "$JQ" ]; then + echo "jq not found in your PATH" + echo "install jq to continue" + exit 1 +fi + +# IMPORT USER DEFINED OPTIONS IF ANY +if [[ -f $RCFILE ]]; then + # shellcheck disable=SC1090 + source "$RCFILE" +fi + +# We prevent the program from running more than one instance: +PIDFILE=/var/tmp/$(basename "$0" .sh).pid + +# Make sure the PID file is removed when we kill the process +trap 'rm -f $PIDFILE; exit 1' TERM INT + +if [[ -r $PIDFILE ]]; then + # PIDFILE exists, so I guess there's already an instance running + # let's kill it and run again + # shellcheck disable=SC2046,SC2086 + kill -s 15 $(cat $PIDFILE) > /dev/null 2>&1 + # should already be deleted by trap, but just to be sure + rm "$PIDFILE" +fi + +# create PIDFILE +echo $PID > "$PIDFILE" + +# Export config to file +function export_config() { + if [ -r ${RCFILE} ]; then + echo "Backing up current '${RCFILE}'...." + mv -f ${RCFILE} ${RCFILE}.$(date +%Y%m%d_%H%M) + fi + echo "Writing '${RCFILE}'...." + sed -n '/^set_defaults() {/,/^} # end set_defaults, do not change this line./p' $0 \ + | grep -v set_defaults \ + | sed -e 's/^\([^=]*\)=\${\1:-\([^}]*\)}/\1=\2/' \ + > ${RCFILE} + if [ -r ${RCFILE} ]; then + echo "Taking no further action." + exit 0 + else + echo "Could not write '${RCFILE}'...!" + exit 1 + fi +} + +# we should expand on this function to add a sample note and explain a little bit +# how the program works. +function firstrun() { + [ -f $RCFILE ] && RC=$RCFILE || RC="none" + + clear + echo "${BASENAME} configuration: + +base directory: ${BASEDIR}/ +notes archive: ${NOTESDIR}/ +notes database: ${DB} +rc file: $RC +text editor: ${EDITOR} +terminal: ${TERMINAL} +jq executable: ${JQ} +" + + read -r -p "Do you wish to continue? (y/N) " ANSWER + case $ANSWER in + y|Y ) + mkdir -p $NOTESDIR + cat << __EOL__ > ${DB} +{ + "params": { + "version": "${VERSION}", + "dbversion": "${DBVERSION}" + }, + "notes": [] +} +__EOL__ + echo; echo "All done, you can now write your first note." + ;; + * ) + echo "No changes made. Exiting" + exit + ;; + esac +} + +# check for notes dir existance and create it in case it doesn't exists +if [[ ! -d $NOTESDIR ]]; then + # we don't have a directory. FIRST RUN? + firstrun +fi diff --git a/SOURCE/main.sh b/SOURCE/main.sh new file mode 100644 index 0000000..da3130a --- /dev/null +++ b/SOURCE/main.sh @@ -0,0 +1,96 @@ +# shellcheck disable=SC2006 +GOPT=$(getopt -o hvpla::e::d::s:: --long help,version,list,plain,userconf,backup::,add::,edit::,delete::,show:: -n 'bash-notes' -- "$@") + +# shellcheck disable=SC2181 +if [ $? != 0 ] ; then helptext >&2 ; exit 1 ; fi + +# Note the quotes around `$GOPT': they are essential! +eval set -- "$GOPT" +unset GOPT + +while true; do + case "$1" in + -h | --help ) + helptext + exit + ;; + -v | --version ) + echo $BASENAME v${VERSION} + exit + ;; + -p | --plain ) + PLAIN=true + shift + ;; + -l | --list ) + listnotes + exit + ;; + -a | --add ) + case "$2" in + '' ) + read -r -p "Title: " TITLE + ;; + * ) + TITLE=$2 + ;; + esac + shift 2 + addnote "$TITLE" + ;; + -e | --edit ) + case "$2" in + '' ) + read -r -p "Note ID: " NOTE + ;; + * ) + NOTE=$2 + ;; + esac + shift 2 + editnote "$NOTE" + ;; + -d | --delete ) + case "$2" in + '' ) + read -r -p "Note ID: " NOTE + ;; + * ) + NOTE=$2 + ;; + esac + shift 2 + rmnote "$NOTE" + ;; + -s | --show ) + case "$2" in + '' ) + read -r -p "Note ID: " NOTE + ;; + * ) + NOTE=$2 + ;; + esac + shift 2 + shownote "$NOTE" + ;; + --userconf ) + export_config + # shellcheck disable=SC2317 + echo "config exported to \"$RCFILE\"" + # shellcheck disable=SC2317 + exit + ;; + -- ) + shift + break + ;; + * ) + break + ;; + esac +done + +if [ -z $1 ]; then + helptext +fi diff --git a/notes.sh b/notes.sh index d3e6a53..5d7ae7e 100755 --- a/notes.sh +++ b/notes.sh @@ -81,6 +81,70 @@ fi # create PIDFILE echo $PID > "$PIDFILE" +# Export config to file +function export_config() { + if [ -r ${RCFILE} ]; then + echo "Backing up current '${RCFILE}'...." + mv -f ${RCFILE} ${RCFILE}.$(date +%Y%m%d_%H%M) + fi + echo "Writing '${RCFILE}'...." + sed -n '/^set_defaults() {/,/^} # end set_defaults, do not change this line./p' $0 \ + | grep -v set_defaults \ + | sed -e 's/^\([^=]*\)=\${\1:-\([^}]*\)}/\1=\2/' \ + > ${RCFILE} + if [ -r ${RCFILE} ]; then + echo "Taking no further action." + exit 0 + else + echo "Could not write '${RCFILE}'...!" + exit 1 + fi +} + +# we should expand on this function to add a sample note and explain a little bit +# how the program works. +function firstrun() { + [ -f $RCFILE ] && RC=$RCFILE || RC="none" + + clear + echo "${BASENAME} configuration: + +base directory: ${BASEDIR}/ +notes archive: ${NOTESDIR}/ +notes database: ${DB} +rc file: $RC +text editor: ${EDITOR} +terminal: ${TERMINAL} +jq executable: ${JQ} +" + + read -r -p "Do you wish to continue? (y/N) " ANSWER + case $ANSWER in + y|Y ) + mkdir -p $NOTESDIR + cat << __EOL__ > ${DB} +{ + "params": { + "version": "${VERSION}", + "dbversion": "${DBVERSION}" + }, + "notes": [] +} +__EOL__ + echo; echo "All done, you can now write your first note." + ;; + * ) + echo "No changes made. Exiting" + exit + ;; + esac +} + +# check for notes dir existance and create it in case it doesn't exists +if [[ ! -d $NOTESDIR ]]; then + # we don't have a directory. FIRST RUN? + firstrun +fi # check if input is a number, returns false or the number itself function check_noteID() { IN=$1 @@ -127,7 +191,6 @@ __NOWCONF__ echo " --userconf : Export User config file" echo "" } - function addnote() { # remove eventually existing temp DB file if [[ -f $TMPDB ]]; then @@ -151,30 +214,6 @@ function addnote() { # shellcheck disable=SC2086,SC2091 $(${TERMINAL} ${TERM_OPTS} ${EDITOR} ${NOTESDIR}/${NOW}) } - -function listnotes() { - # [ $PLAIN == true ] && echo "output is plain text" || echo "output is colored" - if [[ $(ls -A "$NOTESDIR") ]]; then - if [ $PLAIN == false ]; then - echo "listing all notes" - echo "" - fi - [ $PLAIN == false ] && echo "[ID] [TITLE] [CREATED]" - for i in "${NOTESDIR}"/*; do - # shellcheck disable=SC2155 - local fname=$(basename $i) - DATE=$(date -d @${fname} +"%d/%m/%Y %R %z%Z") - # shellcheck disable=SC2016,SC2086 - TITLE=$($JQ -r --arg z $(basename $i) '.notes[] | select(.file == $z) | .title' $DB) - # shellcheck disable=SC2016,SC2086 - ID=$($JQ -r --arg z $(basename $i) '.notes[] | select(.file == $z) | .id' $DB) - [ $PLAIN == false ] && echo "[${ID}] ${TITLE} ${DATE}" || echo "${ID} - ${TITLE} - ${DATE}" - done - else - echo "no notes yet. You can add your first one with: ${BASENAME} -a \"your note title\"" - fi -} - function editnote() { NOTE=$1 # shellcheck disable=SC2155 @@ -198,7 +237,28 @@ function editnote() { exit 1 fi } - +function listnotes() { + # [ $PLAIN == true ] && echo "output is plain text" || echo "output is colored" + if [[ $(ls -A "$NOTESDIR") ]]; then + if [ $PLAIN == false ]; then + echo "listing all notes" + echo "" + fi + [ $PLAIN == false ] && echo "[ID] [TITLE] [CREATED]" + for i in "${NOTESDIR}"/*; do + # shellcheck disable=SC2155 + local fname=$(basename $i) + DATE=$(date -d @${fname} +"%d/%m/%Y %R %z%Z") + # shellcheck disable=SC2016,SC2086 + TITLE=$($JQ -r --arg z $(basename $i) '.notes[] | select(.file == $z) | .title' $DB) + # shellcheck disable=SC2016,SC2086 + ID=$($JQ -r --arg z $(basename $i) '.notes[] | select(.file == $z) | .id' $DB) + [ $PLAIN == false ] && echo "[${ID}] ${TITLE} ${DATE}" || echo "${ID} - ${TITLE} - ${DATE}" + done + else + echo "no notes yet. You can add your first one with: ${BASENAME} -a \"your note title\"" + fi +} function rmnote() { # remove eventually existing temp DB file if [[ -f $TMPDB ]]; then @@ -250,7 +310,6 @@ function rmnote() { fi fi } - function shownote() { NOTE=$1 @@ -268,71 +327,6 @@ function shownote() { $PAGER ${NOTESDIR}/${FILE} fi } - -function export_config() { - if [ -r ${RCFILE} ]; then - echo "Backing up current '${RCFILE}'...." - mv -f ${RCFILE} ${RCFILE}.$(date +%Y%m%d_%H%M) - fi - echo "Writing '${RCFILE}'...." - sed -n '/^set_defaults() {/,/^} # end set_defaults, do not change this line./p' $0 \ - | grep -v set_defaults \ - | sed -e 's/^\([^=]*\)=\${\1:-\([^}]*\)}/\1=\2/' \ - > ${RCFILE} - if [ -r ${RCFILE} ]; then - echo "Taking no further action." - exit 0 - else - echo "Could not write '${RCFILE}'...!" - exit 1 - fi -} - -# we should expand on this function to add a sample note and explain a little bit -# how the program works. -function firstrun() { - [ -f $RCFILE ] && RC=$RCFILE || RC="none" - - clear - echo "${BASENAME} configuration: - -base directory: ${BASEDIR}/ -notes archive: ${NOTESDIR}/ -notes database: ${DB} -rc file: $RC -text editor: ${EDITOR} -terminal: ${TERMINAL} -jq executable: ${JQ} -" - - read -r -p "Do you wish to continue? (y/N) " ANSWER - case $ANSWER in - y|Y ) - mkdir -p $NOTESDIR - cat << __EOL__ > ${DB} -{ - "params": { - "version": "${VERSION}", - "dbversion": "${DBVERSION}" - }, - "notes": [] -} -__EOL__ - echo; echo "All done, you can now write your first note." - ;; - * ) - echo "No changes made. Exiting" - exit - ;; - esac -} - -# check for notes dir existance and create it in case it doesn't exists -if [[ ! -d $NOTESDIR ]]; then - # we don't have a directory. FIRST RUN? - firstrun -fi - # shellcheck disable=SC2006 GOPT=$(getopt -o hvpla::e::d::s:: --long help,version,list,plain,userconf,backup::,add::,edit::,delete::,show:: -n 'bash-notes' -- "$@")