Simple Note System v2.0a2

Changes:
Split script into several different files for easier editting
Added build.sh to compile Simple Note System from tree
Changed config file to config folder; $HOME/.sns now contains configuration and notes

Testing:
Script runs and produces help screen; no further testing done.
This commit is contained in:
Jon-William Lewis
2015-03-18 12:52:00 -05:00
parent 1864543bf5
commit 45717e33b5
13 changed files with 538 additions and 175 deletions

333
sns.sh
View File

@@ -1,24 +1,25 @@
#!/bin/bash
#==========================================================
# Simple Note System, v1.1
# Simple Note System, v2.0a1
# Copyright 2014, Xenese Labs/Sicron-Perion XNF
#==========================================================
PROD_STR="Simple Note System"
VER_STR=v1.1
VER_STR=v2.0a1
#==============================================================================
# Section: Helper Functions
#==============================================================================
function writeconf {
cat > $HOME/.sns << EOF
cat > $HOME/.sns/sns.conf << EOF
#==========================================================
# Simple Note System Config, v1.1
# Simple Note System Config, v2.0a1
# Copyright 2014, Xenese Labs/Sicron-Perion XNF
#==========================================================
#Directory where notes will be stored
BASEDIR=$HOME/notes
ROOTDIR=$HOME/.sns
BASEDIR=$ROOTDIR/notes
#File extension to use (for listing notes)
EXT=note
@@ -32,7 +33,13 @@ ENCRYPTION="FALSE"
ENC_KEY=""
EOF
chmod 600 $HOME/.sns
chmod 600 $ROOTDIR/sns.conf
}
function pause {
read -p " Press [Enter] to continue."
echo ""
}
function help {
@@ -52,22 +59,17 @@ echo " -w | --wconf : Write default configuration to ~/.sns (useful for Encryp
echo ""
}
function pause {
read -p " Press [Enter] to continue."
echo ""
}
#==============================================================================
# End Section: Helper Functions
#==============================================================================
#==============================================================================
# Section: Configuration
#==============================================================================
if [ -r $HOME/.sns ]; then
source $HOME/.sns
if [ -r $HOME/.sns/sns.conf ]; then
source $HOME/.sns/sns.conf
else
BASEDIR=$HOME/notes
ROOTDIR=$HOME/.sns
BASEDIR=$ROOTDIR/notes
EDITOR=vim
EXT=note
fi
@@ -76,7 +78,6 @@ if [ "$ENCRYPTION" == "TRUE" ]; then
if [ -z "$ENC_KEY" ]; then
ERR_NO_KEY="TRUE"
ENCRYPTION="FALSE"
pause
fi
command -v openssl >/dev/null 2>&1 || { ERR_NO_SSL="TRUE"; ENCRYPTION="FALSE"; }
fi
@@ -84,8 +85,8 @@ fi
if [ "$ENCRYPTION" == "TRUE" ]; then
PROD_STR="Simple Note System (Encryption Enabled)"
EXT="$EXT.enc"
if [ ! -d ~/.tmp ]; then
mkdir -p ~/.tmp
if [ ! -d ~/.sns/tmp ]; then
mkdir -p ~/.sns/tmp
fi
fi
@@ -104,8 +105,6 @@ fi
#==============================================================================
# End Section: Read Configuration
#==============================================================================
#==============================================================================
# Section: Argument Parsing
#==============================================================================
@@ -115,51 +114,52 @@ NOTEBOOK=""
SECTION=""
if [ -z "$1" ]; then #If no input was given, print help
help
exit
help
exit
else #Assume the user wants to do something.
ARGS=( "$@" )
for ARG in ${ARGS[@]};do
if [ "$ARG" = "-c" -o "$ARG" = "--create" ]; then CREATE="TRUE"
elif [ "$ARG" = "-d" -o "$ARG" = "--delete" ]; then DELETE="TRUE"
elif [ "$ARG" = "-e" -o "$ARG" = "--edit" ]; then EDIT="TRUE"
elif [ "$ARG" = "-ce" -o "$ARG" = "-ec" ]; then EDIT="TRUE";CREATE="TRUE"
elif [ "$ARG" = "-p" -o "$ARG" = "--print" ]; then PRINT="TRUE"
elif [ "$ARG" = "-l" -o "$ARG" = "--list" ]; then LIST="TRUE"
elif [ "$ARG" = "-h" -o "$ARG" == "--help" ]; then help; exit 0
elif [ "$ARG" = "-w" -o "$ARG" == "--wconf" ]; then writeconf; exit
else
if [ -z "$NAME" -a -n $ARG ]; then
NAME=$ARG
echo "Name: $NAME"
elif [ -z "$NOTEBOOK" -a -n $ARG ]; then
NOTEBOOK=$ARG
echo "Notebook: $NOTEBOOK"
elif [ -z "$SECTION" -a -n $ARG ]; then
SECTION=$ARG
echo "Section: $SECTION"
fi
fi
done
ARGS=( "$@" )
for ARG in ${ARGS[@]};do
if [ "$ARG" = "-c" -o "$ARG" = "--create" ]; then CREATE="TRUE"
elif [ "$ARG" = "-d" -o "$ARG" = "--delete" ]; then DELETE="TRUE"
elif [ "$ARG" = "-e" -o "$ARG" = "--edit" ]; then EDIT="TRUE"
elif [ "$ARG" = "-ce" -o "$ARG" = "-ec" ]; then EDIT="TRUE";CREATE="TRUE"
elif [ "$ARG" = "-p" -o "$ARG" = "--print" ]; then PRINT="TRUE"
elif [ "$ARG" = "-l" -o "$ARG" = "--list" ]; then LIST="TRUE"
elif [ "$ARG" = "-h" -o "$ARG" == "--help" ]; then help; exit 0
elif [ "$ARG" = "-w" -o "$ARG" == "--wconf" ]; then writeconf; exit
else
if [ -z "$NAME" -a -n $ARG ]; then
NAME=$ARG
echo "Name: $NAME"
elif [ -z "$NOTEBOOK" -a -n $ARG ]; then
NOTEBOOK=$ARG
echo "Notebook: $NOTEBOOK"
elif [ -z "$SECTION" -a -n $ARG ]; then
SECTION=$ARG
echo "Section: $SECTION"
fi
fi
done
fi
#==============================================================================
# End Section: Argument Parsing
#==============================================================================
#==============================================================================
#==============================================================================
#
# End of Setup process. By now, we should have a $BASEDIR, $NOTEBOOK, $SECTION,
# $NOTEDIR, and $EXT
#
#==============================================================================
#==============================================================================
#==============================================================================
# Section: Main
#==============================================================================
# If no name or notebook is specified, the create, edit, and print functions will not function properly.
# Check $NAME and $NOTEBOOK and exit if either are empty.
if [ -z "$NAME" -o -z "$NOTEBOOK" ]; then;
echo " ERROR: Insufficient arguments";
help; #Remind the user how to use the script
exit 10;
fi
NOTEDIR=$BASEDIR/$NOTEBOOK/$SECTION/
NOTE=$NOTEDIR$NAME.$EXT
@@ -167,10 +167,113 @@ NOTE=$NOTEDIR$NAME.$EXT
if [ "$ENCRYPTION" == "TRUE" ]; then
NOTE=$NOTE.tmp
fi
#==========================================================================
# Subection: Create
#==========================================================================
if [ -z "$CREATE" -a -z "$EDIT" -a -z "$PRINT" ]; then #If no action specified, print help and exit
help
exit
else
if [ "$CREATE" == "TRUE" ]; then
if [ -e $NOTE -o -e ${NOTE%.*} ]; then
echo ""
echo "ERROR: Note already exists"
echo "Hint: use -e to edit the note."
echo ""
exit
else
#Create any necessary folders
mkdir -p $NOTEDIR
#Fill in title
echo "TITLE: $NAME" > $NOTE
#Fill the second line with the date
echo "DATE: $(date)" >> $NOTE
if [ "$ENCRYPTION" == "TRUE" ]; then
if [ $EDIT == "FALSE" ]; then
openssl enc -aes-256-cbc -salt -in $NOTE -out ${NOTE%.*} -pass pass:$ENC_KEY
fi
fi
fi
fi
# delete.sns.sh
if [ "$DELETE" == "TRUE" ]; then
if [ -e $NOTE -o -e ${NOTE%.*} ]; then
if [ "$ENCRYPTION" == "TRUE" ]; then
rm ${NOTE%.*}
else
rm $NOTE
fi
echo ""
echo "Deleted note: $NOTEBOOK/$SECTION$NAME."
exit
else
echo ""
echo "ERROR: Note $NOTEBOOK/$SECTION$NAME does not exist."
exit
fi
fi
#==========================================================================
# Subection: List
# Subection: Edit
#==========================================================================
if [ "$EDIT" == "TRUE" ]; then
if [ -r "$NOTE" -o -r ${NOTE%.*} ]; then
if [ -z "$CREATE" ]; then
if [ "$ENCRYPTION" == "TRUE" ]; then
TMP_NAME=$ROOTDIR/tmp/$RANDOM
openssl enc -d -aes-256-cbc -in ${NOTE%.*} -pass pass:$ENC_KEY > $TMP_NAME
echo "" >> $TMP_NAME
echo "EDIT $(date)" >> $TMP_NAME
else
echo "" >> $NOTE
echo "EDIT $(date)" >> $NOTE
fi
fi
$EDITOR $NOTE
if [ "$ENCRYPTION" == "TRUE" ]; then
openssl enc -aes-256-cbc -salt -in $NOTE -out ${NOTE%.*} -pass pass:$ENC_KEY
rm $NOTE
fi
else
echo ""
echo "ERROR: Note cannot be opened for editting."
echo ""
fi
fi
fi
#==========================================================================
# Subection: Print
#==========================================================================
if [ "$PRINT" == "TRUE" ]; then
if [ -r "$NOTE" -o -r ${NOTE%.*} ]; then
if [ -z "$CREATE" ]; then
if [ "$ENCRYPTION" == "TRUE" ]; then
openssl enc -d -aes-256-cbc -in ${NOTE%.*} -pass pass:$ENC_KEY
else
cat $NOTE
echo "" >> $NOTE
fi
else
echo ""
echo "ERROR: Note cannot be found."
echo ""
fi
fi
fi
# list.sns.sh
if [ -n "$LIST" ]; then
NOTEBOOK="$NAME" #In case of a list command, arg parsing fails.
if [ -z "$NOTEBOOK" ]; then
@@ -208,119 +311,3 @@ fi
fi
exit
fi
#======================================================================
# Sanity Check - Actions below require a valid $NAME and $NOTEBOOK
#======================================================================
if [ -z "$NAME" -o -z "$NOTEBOOK" ]; then
echo " ERROR: Insufficient arguments"
help
exit 10
fi
#==========================================================================
# Subection: Delete
#==========================================================================
if [ "$DELETE" == "TRUE" ]; then
if [ -e $NOTE -o -e ${NOTE%.*} ]; then
if [ "$ENCRYPTION" == "TRUE" ]; then
rm ${NOTE%.*}
else
rm $NOTE
fi
echo ""
echo "Deleted note: $NOTEBOOK/$SECTION$NAME."
exit
else
echo ""
echo "ERROR: Note $NOTEBOOK/$SECTION$NAME does not exist."
exit
fi
fi
#==========================================================================
# Subection: Create
#==========================================================================
if [ -z "$CREATE" -a -z "$EDIT" -a -z "$PRINT" ]; then #If no action specified, print help and exit
help
exit
else
if [ "$CREATE" == "TRUE" ]; then
if [ -e $NOTE -o -e ${NOTE%.*} ]; then
echo ""
echo "ERROR: Note already exists"
echo "Hint: use -e to edit the note."
echo ""
exit
else
#Create any necessary folders
mkdir -p $NOTEDIR
#Fill in title
echo "TITLE: $NAME" > $NOTE
#Fill the second line with the date
echo "DATE: $(date)" >> $NOTE
if [ "$ENCRYPTION" == "TRUE" ]; then
if [ $EDIT == "FALSE" ]; then
openssl enc -aes-256-cbc -salt -in $NOTE -out ${NOTE%.*} -pass pass:$ENC_KEY
fi
fi
fi
fi
#==========================================================================
# Subection: Edit
#==========================================================================
if [ "$EDIT" == "TRUE" ]; then
if [ -r "$NOTE" -o -r ${NOTE%.*} ]; then
if [ -z "$CREATE" ]; then
if [ "$ENCRYPTION" == "TRUE" ]; then
openssl enc -d -aes-256-cbc -in ${NOTE%.*} -pass pass:$ENC_KEY > $NOTE
fi
echo "" >> $NOTE
echo "EDIT $(date)" >> $NOTE
fi
$EDITOR $NOTE
if [ "$ENCRYPTION" == "TRUE" ]; then
openssl enc -aes-256-cbc -salt -in $NOTE -out ${NOTE%.*} -pass pass:$ENC_KEY
rm $NOTE
fi
else
echo ""
echo "ERROR: Note cannot be opened for editting."
echo ""
fi
fi
fi
#==========================================================================
# Subection: Print
#==========================================================================
if [ "$PRINT" == "TRUE" ]; then
if [ -r "$NOTE" -o -r ${NOTE%.*} ]; then
if [ -z "$CREATE" ]; then
if [ "$ENCRYPTION" == "TRUE" ]; then
openssl enc -d -aes-256-cbc -in ${NOTE%.*} -pass pass:$ENC_KEY
else
cat $NOTE
echo "" >> $NOTE
fi
else
echo ""
echo "ERROR: Note cannot be found."
echo ""
fi
fi
fi
exit