[bash-notes.git] / notes.sh

#! /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"

# 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 [\"<title>\"]	: 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 ""
}

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})
}

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
	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
}

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
}

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
}

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' -- "$@")

# 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
Commit	Line	Data
a4aaf855	1	#! /bin/bash
a4aaf855	2
6c152f7e	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/
	5
cb8fcb2f	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
	11	BASH_XTRACEFD="5"
	12	PS4='$LINENO: '
	13	set -x
	14	fi
a4aaf855	15
a4aaf855	16	PID=$$
ad818a9d	17	BASENAME=$( basename "$0" )
	18	NOW=$(date +%s)
	19
	20	VERSION="0.3"
	21	DBVERSION=${VERSION}_${NOW}
53f2ed57	22
d80ac20a	23	set_defaults() {
d80ac20a	24	# Binaries to use
cb8fcb2f	25	JQ=${JQ:-/usr/bin/jq}
a4aaf855	26	EDITOR=${EDITOR:-/usr/bin/vim}
53f2ed57	27	TERMINAL=${TERMINAL:-/usr/bin/alacritty}
b648c006	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
e3670e83	31	TERM_OPTS="--class notes --title notes -e "
ad818a9d	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}
53f2ed57	35
cb8fcb2f	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
	38	PLAIN=false
d80ac20a	39	# base directory for program files
53f2ed57	40	BASEDIR=${BASEDIR:-~/.local/share/bash-notes}
d80ac20a	41	# notes database in json format
a4aaf855	42	DB=${BASEDIR}/db.json
d80ac20a	43	# directory containing the actual notes
a4aaf855	44	NOTESDIR=${BASEDIR}/notes
53f2ed57	45
d80ac20a	46	} # end set_defaults, do not change this line.
	47
	48	set_defaults
	49
	50	# Do not edit below this point
	51	RCFILE=${RCFILE:-~/.config/bash-notes.rc}
53f2ed57	52	TMPDB=/tmp/db.json
a4aaf855	53
b9f21021	54	if [ ! -x "$JQ" ]; then
a4aaf855	55	echo "jq not found in your PATH"
	56	echo "install jq to continue"
	57	exit 1
	58	fi
	59
53f2ed57	60	# IMPORT USER DEFINED OPTIONS IF ANY
53f2ed57	61	if [[ -f $RCFILE ]]; then
b9f21021	62	# shellcheck disable=SC1090
b9f21021	63	source "$RCFILE"
53f2ed57	64	fi
53f2ed57	65
a4aaf855	66	# We prevent the program from running more than one instance:
b9f21021	67	PIDFILE=/var/tmp/$(basename "$0" .sh).pid
a4aaf855	68
	69	# Make sure the PID file is removed when we kill the process
	70	trap 'rm -f $PIDFILE; exit 1' TERM INT
	71
	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
b9f21021	75	# shellcheck disable=SC2046,SC2086
a4aaf855	76	kill -s 15 $(cat $PIDFILE) > /dev/null 2>&1
a4aaf855	77	# should already be deleted by trap, but just to be sure
b9f21021	78	rm "$PIDFILE"
a4aaf855	79	fi
	80
	81	# create PIDFILE
b9f21021	82	echo $PID > "$PIDFILE"
a4aaf855	83
61c91990	84	# check if input is a number, returns false or the number itself
	85	function check_noteID() {
	86	IN=$1
	87	case $IN in
	88	''\|[!0-9])
	89	return 1
	90	;;
	91	*)
b9f21021	92	echo "$IN"
61c91990	93	;;
	94	esac
	95	}
	96
a4aaf855	97	function helptext() {
d80ac20a	98	echo "Usage:"
c018122c	99	echo " $0 [PARAMS] ..."
d80ac20a	100	echo ""
	101	cat << __NOWCONF__
	102	${BASENAME} configuration is:
	103
	104	base directory: ${BASEDIR}/
	105	notes archive: ${NOTESDIR}/
	106	notes database: ${DB}
	107	rc file: $RCFILE
cb8fcb2f	108	debug file: /tmp/debug_bash-note.log
c018122c	109
d80ac20a	110	text editor: ${EDITOR}
	111	terminal: ${TERMINAL}
	112	jq executable: ${JQ}
	113	__NOWCONF__
	114
	115	echo ""
e3670e83	116	echo "${BASENAME} parameters are:"
d80ac20a	117	echo " -h \| --help : This help text"
c018122c	118	echo " -p \| --plain : Output is in plain text"
b648c006	119	echo " (without this option the output is formatted)"
b648c006	120	echo " (this option must precede all others)"
d80ac20a	121	echo " -l \| --list : List existing notes"
026502da	122	echo " -a \| --add [\"<title>\"] : Add new note"
6c152f7e	123	echo " -e \| --edit [<note>] : Edit note"
026502da	124	echo " -d \| --delete [<note> \| all] : Delete single note or all notes at once"
ad818a9d	125	echo " -s \| --show [<note>] : Display note using your favourite PAGER"
d80ac20a	126	echo " -v \| --version : Print version"
d80ac20a	127	echo " --userconf : Export User config file"
e3670e83	128	echo ""
a4aaf855	129	}
	130
	131	function addnote() {
026502da	132	# remove eventually existing temp DB file
	133	if [[ -f $TMPDB ]]; then
	134	rm $TMPDB
	135	fi
	136
53f2ed57	137	NOTETITLE="$1"
53f2ed57	138	echo "adding new note - \"$NOTETITLE\""
b9f21021	139	# shellcheck disable=SC2086
e3670e83	140	LASTID=$($JQ '.notes[-1].id // 0 \| tonumber' $DB)
e3670e83	141	# [ "" == $LASTID ] && LASTID=0
b9f21021	142	NOTEID=$(( LASTID + 1 ))
b9f21021	143	# shellcheck disable=SC2086
a4aaf855	144	touch ${NOTESDIR}/${NOW}
b9f21021	145	# shellcheck disable=SC2016
a4aaf855	146	$JQ --arg i "$NOTEID" --arg t "$NOTETITLE" --arg f "$NOW" '.notes += [{"id": $i, "title": $t, "file": $f}]' "$DB" > $TMPDB
b9f21021	147	# shellcheck disable=SC2086
a4aaf855	148	mv $TMPDB $DB
b648c006	149	# example for alacritty:
b648c006	150	# alacritty --class notes --title notes -e /usr/bin/vim ...
b9f21021	151	# shellcheck disable=SC2086,SC2091
e3670e83	152	$(${TERMINAL} ${TERM_OPTS} ${EDITOR} ${NOTESDIR}/${NOW})
a4aaf855	153	}
	154
	155	function listnotes() {
e3670e83	156	# [ $PLAIN == true ] && echo "output is plain text" \|\| echo "output is colored"
b9f21021	157	if [[ $(ls -A "$NOTESDIR") ]]; then
b648c006	158	if [ $PLAIN == false ]; then
	159	echo "listing all notes"
	160	echo ""
	161	fi
	162	[ $PLAIN == false ] && echo "[ID] [TITLE] [CREATED]"
b9f21021	163	for i in "${NOTESDIR}"/*; do
b9f21021	164	# shellcheck disable=SC2155
b648c006	165	local fname=$(basename $i)
b648c006	166	DATE=$(date -d @${fname} +"%d/%m/%Y %R %z%Z")
b9f21021	167	# shellcheck disable=SC2016,SC2086
e3670e83	168	TITLE=$($JQ -r --arg z $(basename $i) '.notes[] \| select(.file == $z) \| .title' $DB)
b9f21021	169	# shellcheck disable=SC2016,SC2086
e3670e83	170	ID=$($JQ -r --arg z $(basename $i) '.notes[] \| select(.file == $z) \| .id' $DB)
b648c006	171	[ $PLAIN == false ] && echo "[${ID}] ${TITLE} ${DATE}" \|\| echo "${ID} - ${TITLE} - ${DATE}"
e3670e83	172	done
	173	else
	174	echo "no notes yet. You can add your first one with: ${BASENAME} -a \"your note title\""
	175	fi
a4aaf855	176	}
	177
	178	function editnote() {
61c91990	179	NOTE=$1
b9f21021	180	# shellcheck disable=SC2155
	181	local OK=$(check_noteID "$NOTE")
	182	if [ ! "$OK" ]; then
61c91990	183	echo "invalid note \"$NOTE\""
b9f21021	184	echo "Use the note ID that you can fetch after listing your notes"
61c91990	185	exit 1
	186	fi
	187
b9f21021	188	# shellcheck disable=SC2016,SC2086
61c91990	189	TITLE=$($JQ --arg i $OK '.notes[] \| select(.id == $i) \| .title' $DB)
b9f21021	190	# shellcheck disable=SC2016,SC2086
61c91990	191	FILE=$($JQ -r --arg i $OK '.notes[] \| select(.id == $i) \| .file' $DB)
44abbfe7	192	if [ "$TITLE" ]; then
44abbfe7	193	echo "editing note $TITLE"
b9f21021	194	# shellcheck disable=SC2086,SC2091
b648c006	195	$(${TERMINAL} ${TERM_OPTS} ${EDITOR} ${NOTESDIR}/${FILE})
44abbfe7	196	else
	197	echo "note not found"
	198	exit 1
	199	fi
a4aaf855	200	}
a4aaf855	201
a4aaf855	202	function rmnote() {
026502da	203	# remove eventually existing temp DB file
	204	if [[ -f $TMPDB ]]; then
	205	rm $TMPDB
b648c006	206	fi
b648c006	207
026502da	208	NOTE=$1
b9f21021	209	if [ "all" == "$NOTE" ]; then
026502da	210	echo "You're going to delete all notes."
	211	read -r -p "Do you wish to continue? (y/N) " ANSWER
	212	case $ANSWER in
	213	y\|Y )
b9f21021	214	# shellcheck disable=SC2086
026502da	215	$JQ 'del(.notes[])' $DB > $TMPDB
b9f21021	216	# shellcheck disable=SC2086
026502da	217	mv $TMPDB $DB
b9f21021	218	# shellcheck disable=SC2086
026502da	219	rm $NOTESDIR/*
	220	echo "Deleted all notes"
	221	;;
	222	* )
	223	echo "Aborting, no notes were deleted."
	224	exit 1
	225	;;
	226	esac
b648c006	227	else
b9f21021	228	# shellcheck disable=SC2155
	229	local OK=$(check_noteID "$NOTE")
	230	if [ ! "$OK" ]; then
026502da	231	echo "invalid note \"$NOTE\""
b9f21021	232	echo "Use the note ID that you can fetch after listing your notes"
026502da	233	exit 1
	234	fi
	235
b9f21021	236	# shellcheck disable=SC2016,SC2086
026502da	237	TITLE=$($JQ --arg i $OK '.notes[] \| select(.id == $i) \| .title' $DB)
b9f21021	238	# shellcheck disable=SC2016,SC2086
026502da	239	FILE=$($JQ -r --arg i $OK '.notes[] \| select(.id == $i) \| .file' $DB)
026502da	240	if [ "$TITLE" ]; then
ad818a9d	241	# shellcheck disable=SC2016,SC2086
	242	$JQ -r --arg i $OK 'del(.notes[] \| select(.id == $i))' $DB > $TMPDB
	243	# shellcheck disable=SC2086
	244	mv $TMPDB $DB
	245	rm $NOTESDIR/$FILE
	246	echo "Deleted note $TITLE"
026502da	247	else
	248	echo "note not found"
	249	exit 1
	250	fi
b648c006	251	fi
a4aaf855	252	}
a4aaf855	253
ad818a9d	254	function shownote() {
	255	NOTE=$1
	256
	257	# shellcheck disable=SC2155
	258	local OK=$(check_noteID "$NOTE")
	259	if [ ! "$OK" ]; then
	260	echo "invalid note \"$NOTE\""
	261	echo "Use the note ID that you can fetch after listing your notes"
	262	exit 1
	263	fi
	264
	265	FILE=$($JQ -r --arg i $OK '.notes[] \| select(.id == $i) \| .file' $DB)
	266
	267	if [ "$FILE" ]; then
	268	$PAGER ${NOTESDIR}/${FILE}
	269	fi
	270	}
	271
d80ac20a	272	function export_config() {
	273	if [ -r ${RCFILE} ]; then
	274	echo "Backing up current '${RCFILE}'...."
	275	mv -f ${RCFILE} ${RCFILE}.$(date +%Y%m%d_%H%M)
	276	fi
	277	echo "Writing '${RCFILE}'...."
	278	sed -n '/^set_defaults() {/,/^} # end set_defaults, do not change this line./p' $0 \
	279	\| grep -v set_defaults \
	280	\| sed -e 's/^\([^=]\)=\${\1:-\([^}]\)}/\1=\2/' \
	281	> ${RCFILE}
	282	if [ -r ${RCFILE} ]; then
	283	echo "Taking no further action."
	284	exit 0
	285	else
	286	echo "Could not write '${RCFILE}'...!"
	287	exit 1
	288	fi
	289	}
	290
53f2ed57	291	# we should expand on this function to add a sample note and explain a little bit
53f2ed57	292	# how the program works.
a4aaf855	293	function firstrun() {
53f2ed57	294	[ -f $RCFILE ] && RC=$RCFILE \|\| RC="none"
	295
	296	clear
	297	echo "${BASENAME} configuration:
	298
	299	base directory: ${BASEDIR}/
	300	notes archive: ${NOTESDIR}/
	301	notes database: ${DB}
	302	rc file: $RC
	303	text editor: ${EDITOR}
	304	terminal: ${TERMINAL}
	305	jq executable: ${JQ}
	306	"
	307
	308	read -r -p "Do you wish to continue? (y/N) " ANSWER
	309	case $ANSWER in
	310	y\|Y )
	311	mkdir -p $NOTESDIR
d80ac20a	312	cat << __EOL__ > ${DB}
a4aaf855	313	{
d80ac20a	314	"params": {
d80ac20a	315	"version": "${VERSION}",
ad818a9d	316	"dbversion": "${DBVERSION}"
d80ac20a	317	},
a4aaf855	318	"notes": []
	319	}
	320	__EOL__
d80ac20a	321	echo; echo "All done, you can now write your first note."
53f2ed57	322	;;
	323	* )
	324	echo "No changes made. Exiting"
	325	exit
	326	;;
	327	esac
a4aaf855	328	}
	329
	330	# check for notes dir existance and create it in case it doesn't exists
	331	if [[ ! -d $NOTESDIR ]]; then
	332	# we don't have a directory. FIRST RUN?
	333	firstrun
	334	fi
	335
b9f21021	336	# shellcheck disable=SC2006
ad818a9d	337	GOPT=$(getopt -o hvpla::e::d::s:: --long help,version,list,plain,userconf,backup::,add::,edit::,delete::,show:: -n 'bash-notes' -- "$@")
53f2ed57	338
b9f21021	339	# shellcheck disable=SC2181
cb8fcb2f	340	if [ $? != 0 ] ; then helptext >&2 ; exit 1 ; fi
53f2ed57	341
	342	# Note the quotes around `$GOPT': they are essential!
	343	eval set -- "$GOPT"
ad818a9d	344	unset GOPT
53f2ed57	345
	346	while true; do
	347	case "$1" in
	348	-h \| --help )
	349	helptext
	350	exit
	351	;;
	352	-v \| --version )
	353	echo $BASENAME v${VERSION}
	354	exit
	355	;;
c018122c	356	-p \| --plain )
	357	PLAIN=true
	358	shift
	359	;;
53f2ed57	360	-l \| --list )
	361	listnotes
	362	exit
	363	;;
	364	-a \| --add )
ad818a9d	365	case "$2" in
	366	'' )
	367	read -r -p "Title: " TITLE
	368	;;
	369	* )
	370	TITLE=$2
	371	;;
	372	esac
53f2ed57	373	shift 2
	374	addnote "$TITLE"
	375	;;
6c152f7e	376	-e \| --edit )
ad818a9d	377	case "$2" in
	378	'' )
	379	read -r -p "Note ID: " NOTE
	380	;;
	381	* )
	382	NOTE=$2
	383	;;
	384	esac
53f2ed57	385	shift 2
	386	editnote "$NOTE"
	387	;;
b648c006	388	-d \| --delete )
ad818a9d	389	case "$2" in
	390	'' )
	391	read -r -p "Note ID: " NOTE
	392	;;
	393	* )
	394	NOTE=$2
	395	;;
	396	esac
53f2ed57	397	shift 2
	398	rmnote "$NOTE"
	399	;;
ad818a9d	400	-s \| --show )
	401	case "$2" in
	402	'' )
	403	read -r -p "Note ID: " NOTE
	404	;;
	405	* )
	406	NOTE=$2
	407	;;
	408	esac
	409	shift 2
	410	shownote "$NOTE"
	411	;;
d80ac20a	412	--userconf )
d80ac20a	413	export_config
b9f21021	414	# shellcheck disable=SC2317
d80ac20a	415	echo "config exported to \"$RCFILE\""
b9f21021	416	# shellcheck disable=SC2317
d80ac20a	417	exit
53f2ed57	418	;;
53f2ed57	419	-- )
026502da	420	shift
026502da	421	break
53f2ed57	422	;;
	423	* )
	424	break
	425	;;
	426	esac
a4aaf855	427	done
a4aaf855	428
ad818a9d	429	if [ -z $1 ]; then
	430	helptext
	431	fi