PID=$$
VERSION="0.1"
+
+set_defaults() {
+# Binaries to use
EDITOR=${EDITOR:-/usr/bin/vim}
-BASEDIR=${BASEDIR:-~/.bash-notes}
+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 "
+JQ=${JQ:-/usr/bin/jq}
+
+# base directory for program files
+BASEDIR=${BASEDIR:-~/.local/share/bash-notes}
+# notes database in json format
DB=${BASEDIR}/db.json
-TMPDB=/tmp/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
BASENAME=$( basename $0 )
-TERMINAL=${TERMINAL:-/usr/bin/alacritty}
-JQ=$(which jq)
+NOW=$(date +%s)
if [ ! -x $JQ ]; then
echo "jq not found in your PATH"
exit 1
fi
+# IMPORT USER DEFINED OPTIONS IF ANY
+if [[ -f $RCFILE ]]; then
+ source $RCFILE
+fi
+
# We prevent the program from running more than one instance:
PIDFILE=/var/tmp/$(basename $0 .sh).pid
# create PIDFILE
echo $PID > $PIDFILE
+# 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 "Parameters are:"
- echo " -h : This help text"
- echo " -s <directory> : specify directory where to store all notes."
- echo " -e <editor> : specify EDITOR for this session only."
- echo " -l : List existing notes"
- echo " -a : Add new note"
- echo " -m <note> : Modify note"
- echo " -d <note> : Modify date for note"
- echo " -r <note> : Remove note"
- echo " -v : Print version"
+ echo "Usage:"
+ echo " $0 [PARAMS] ..."
+ echo ""
+ cat << __NOWCONF__
+${BASENAME} configuration is:
+
+base directory: ${BASEDIR}/
+notes archive: ${NOTESDIR}/
+notes database: ${DB}
+rc file: $RCFILE
+
+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 [\"<title>\"] : Add new note"
+ echo " -m | --modify [<note>] : Modify note"
+ echo " -d | --delete [<note> | all] : Delete single note or all notes at once"
+ echo " -v | --version : Print version"
+ echo " --userconf : Export User config file"
+ echo ""
}
function addnote() {
- NOTETITLE=$1
- echo "add new note"
- NOW=$(date +%s)
- FILEDATE=$(date -d @$NOW +%d/%m/%Y_%T)
- LASTID=$($JQ '.notes[-1].id' $DB)
- [ null == $LASTID ] && LASTID=0
+ # remove eventually existing temp DB file
+ if [[ -f $TMPDB ]]; then
+ rm $TMPDB
+ fi
+
+ NOTETITLE="$1"
+ echo "adding new note - \"$NOTETITLE\""
+ LASTID=$($JQ '.notes[-1].id // 0 | tonumber' $DB)
+ # [ "" == $LASTID ] && LASTID=0
NOTEID=$(( $LASTID + 1 ))
touch ${NOTESDIR}/${NOW}
$JQ --arg i "$NOTEID" --arg t "$NOTETITLE" --arg f "$NOW" '.notes += [{"id": $i, "title": $t, "file": $f}]' "$DB" > $TMPDB
mv $TMPDB $DB
- NEWNOTE=$(${TERMINAL} --class notes --title notes -e ${EDITOR} ${NOTESDIR}/${NOW})
- if [[ $NEWNOTE ]]; then
- echo "New note saved!"
- fi
+ # example for alacritty:
+ # alacritty --class notes --title notes -e /usr/bin/vim ...
+ $(${TERMINAL} ${TERM_OPTS} ${EDITOR} ${NOTESDIR}/${NOW})
}
function listnotes() {
- echo "list all notes"
+ # [ $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
+ local fname=$(basename $i)
+ DATE=$(date -d @${fname} +"%d/%m/%Y %R %z%Z")
+ TITLE=$($JQ -r --arg z $(basename $i) '.notes[] | select(.file == $z) | .title' $DB)
+ 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() {
- echo "edit note \"${1}\""
-}
+ NOTE=$1
+ local OK=$(check_noteID $NOTE)
+ if [ ! $OK ]; then
+ echo "invalid note \"$NOTE\""
+ exit 1
+ fi
-function datenote() {
- echo "edit date for note \"${1}\""
+ TITLE=$($JQ --arg i $OK '.notes[] | select(.id == $i) | .title' $DB)
+ FILE=$($JQ -r --arg i $OK '.notes[] | select(.id == $i) | .file' $DB)
+ if [ "$TITLE" ]; then
+ echo "editing note $TITLE"
+ $(${TERMINAL} ${TERM_OPTS} ${EDITOR} ${NOTESDIR}/${FILE})
+ else
+ echo "note not found"
+ exit 1
+ fi
}
function rmnote() {
- echo "remove note"
+ # 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 )
+ $JQ 'del(.notes[])' $DB > $TMPDB
+ mv $TMPDB $DB
+ rm $NOTESDIR/*
+ echo "Deleted all notes"
+ ;;
+ * )
+ echo "Aborting, no notes were deleted."
+ exit 1
+ ;;
+ esac
+ else
+ local OK=$(check_noteID $NOTE)
+ if [ ! $OK ]; then
+ echo "invalid note \"$NOTE\""
+ exit 1
+ fi
+
+ TITLE=$($JQ --arg i $OK '.notes[] | select(.id == $i) | .title' $DB)
+ FILE=$($JQ -r --arg i $OK '.notes[] | select(.id == $i) | .file' $DB)
+ if [ "$TITLE" ]; then
+ $JQ -r --arg i $OK 'del(.notes[] | select(.id == $i))' $DB > $TMPDB
+ mv $TMPDB $DB
+ rm $NOTESDIR/$FILE
+ echo "Deleted note $TITLE"
+ else
+ echo "note not found"
+ exit 1
+ fi
+ 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() {
- mkdir -p $NOTESDIR
- cat << "__EOL__" > $DB
+ [ -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": "${NOW}"
+ },
"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
firstrun
fi
-# Command line parameter processing:
-while getopts ":a:hlvm:s:n:e:r:d:" Option
-do
- case $Option in
- h ) helptext
- exit
- ;;
- a ) TITLE=${OPTARG}
- addnote $TITLE
- ;;
- l ) listnotes
- ;;
- m ) NOTE=${OPTARG}
- editnote "${NOTE}"
- ;;
- d ) NOTE=${OPTARG}
- datenote "${NOTE}"
- ;;
- r ) NOTE=${OPTARG}
- rmnote "${NOTE}"
- ;;
- e ) EDITOR=${OPTARG}
- ;;
- s ) NOTESDIR=${OPTARG}
- ;;
- v ) echo $BASENAME v${VERSION}
- ;;
- * ) echo "You passed an illegal switch to the program!"
- echo "Run '$0 -h' for more help."
- exit
- ;; # DEFAULT
- esac
-done
+# NOTE: This requires GNU getopt. On Mac OS X and FreeBSD, you have to install this
+# separately; see below.
+GOPT=`getopt -o hvpla:m:d: --long help,version,list,plain,userconf,add:,modify:,delete:,editor:,storage: \
+ -n 'bash-notes' -- "$@"`
-# End of option parsing.
-shift $(($OPTIND - 1))
-# $1 now references the first non option item supplied on the command line
-# if one exists.
-# ---------------------------------------------------------------------------
+if [ $? != 0 ] ; then echo "Terminating..." >&2 ; exit 1 ; fi
+
+# Note the quotes around `$GOPT': they are essential!
+eval set -- "$GOPT"
+
+PLAIN=false
+
+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 )
+ TITLE="$2"
+ shift 2
+ addnote "$TITLE"
+ ;;
+ -m | --modify )
+ NOTE="$2"
+ shift 2
+ editnote "$NOTE"
+ ;;
+ -d | --delete )
+ NOTE="$2"
+ shift 2
+ rmnote "$NOTE"
+ ;;
+ --userconf )
+ export_config
+ echo "config exported to \"$RCFILE\""
+ exit
+ ;;
+ -- )
+ shift
+ break
+ ;;
+ * )
+ break
+ ;;
+ esac
+done
