xenami/vns
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'SNSv2' of alfheim:xilmwa/sns into SNSv2

Browse Source
This commit is contained in:
Jon-William Lewis
2016-02-15 10:31:48 -06:00
parent 16b9d5c469 037fd9c2fa
commit 86fb0d2019
22 changed files with 239 additions and 813 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
.DS_Store vendored
View File

Binary file not shown.

40
README.md
View File

@@ -1,19 +1,31 @@
Simple Note System Simple Note System
================== ==================
The Simple Note System is a shell script enabling easy management of plain-text The Simple Note System is a shell script partially inspired by [pass], in that
notes. SNS depends on OpenSSL for encryption and uses the vim editor by default. it stores notes as normal, plaintext, files in normal folders. It uses the
environment-specified editor, and can be configured to use GPG encryption.
usage: sns [-ce] NAME NOTEBOOK SECTION" SNS was originally conceived one morning during an update to a popular note-taking
sns [-d ] NAME NOTEBOOK SECTION" app. The thought occurred that a note system need not reinvent the wheel with
sns [-lp] NOTEBOOK" its own GUI editor and proprietary file format, but instead could use the tools
sns [-w ]" already provided by the operating system.
sns [-h ]"
-c | --create : Create note" As it developed, OpenSSL encryption was dropped in favor of GPG, and the script
-d | --delete : Delete note" was almost entirely rewritten as SNSv2.
-e | --edit : Open note for editing"
-h | --help : Display this message" simple note system
-p | --print : Print note to console" ==================
-l | --list : List all notes in NOTEBOOK"
-w | --wconf : Rewrite default configuration" usage: sns [-cedp] NAME NOTEBOOK SECTION
sns [-l] NOTEBOOK
sns [-hi]
-c | --create : Create note
-d | --delete : Delete note
-e | --edit : Open note for editing
-h | --help : Display this message
-p | --print : Print note to console
-l | --list : List all notes in NOTEBOOK
-i | --init : Write default config and initalize SNS store"
[pass]: http://passwordstore.org

21
build.sh
View File

@@ -1,29 +1,28 @@
#!/bin/bash
#==========================================================
# Simple Note System - Build Script
# Copyright 2016, Xenese Labs/Sicron-Perion XNF
#==========================================================
S=sns.sh S=sns.sh
bash header.sh > "$S" bash header.sh > "$S"
echo -e "\n# Section: Functions" >> "$S" echo -e "\n# Section: Functions" >> "$S"
cat ./src/includes/create_sns_root.sns.sh >> "$S" cat ./src/includes/init_store.sns.sh >> "$S"
cat ./src/includes/verify_store.sns.sh >> "$S"
cat ./src/includes/pause.sns.sh >> "$S" cat ./src/includes/pause.sns.sh >> "$S"
cat ./src/includes/help.sns.sh >> "$S" cat ./src/includes/help.sns.sh >> "$S"
cat ./src/includes/p_header.sh >> "$S" cat ./src/includes/p_header.sh >> "$S"
cat ./src/includes/libencryption.sh >> "$S" cat ./src/includes/libencryption.sns.sh >> "$S"
cat ./src/includes/create.sns.sh >> "$S" cat ./src/includes/create.sns.sh >> "$S"
cat ./src/includes/delete.sns.sh >> "$S" cat ./src/includes/delete.sns.sh >> "$S"
cat ./src/includes/edit.sns.sh >> "$S" cat ./src/includes/edit.sns.sh >> "$S"
cat ./src/includes/print.sns.sh >> "$S" cat ./src/includes/print.sns.sh >> "$S"
cat ./src/includes/list.sns.sh >> "$S" cat ./src/includes/list.sns.sh >> "$S"
printf "%s\n\n\n\n" "# End Section: Functions" >> "$S" printf "%s\n\n\n\n" "# End Section: Functions" >> "$S"
printf "\n" >> "$S"
printf "%s\n" "###############################################################################" >> "$S"
printf "%s\n" "#==============================================================================" >> "$S"
printf "%s\n" "# Begin Main Program" >> "$S"
printf "%s\n" "#==============================================================================" >> "$S"
printf "%s\n" "###############################################################################" >> "$S"
printf "\n" >> "$S"
cat ./src/main/stage1.sns.sh >> "$S" cat ./src/main/stage1.sns.sh >> "$S"
cat ./src/main/stage2.sns.sh >> "$S" cat ./src/main/stage2.sns.sh >> "$S"
cat ./src/main/stage3.sns.sh >> "$S" cat ./src/main/stage3.sns.sh >> "$S"
chmod u+x "$S"
exit exit

12
errors.ref
View File

@@ -3,10 +3,12 @@ Error Code Reference
General------------------------------------------------------------------------- General-------------------------------------------------------------------------
ERR_NO_ARGS 10 No arguments were specified ERR_NO_ARGS 10 No arguments were specified
ERR_NO_OP 20 ERR_NO_OP 20 No operation was specified
ERR_INSUFFICIENT_ARGS 30 A required argument was not provided ERR_NO_NOTE 30 A required argument was not provided
Encryption---------------------------------------------------------------------- Encryption----------------------------------------------------------------------
ERR_NO_GPG 100 GPG is not installed ERR_NO_GPG 100 Encryption is enabled, but GPG is not installed
ERR_NO_KEY 110 No recipient specified ERR_NO_KEY 110 Encryption is enabled, but no recipient was specified
Create--------------------------------------------------------------------------
ERR_NOTE_EXiSTS 200 The specified note already exists

15
header.sh
View File

@@ -1,22 +1,27 @@
#!/bin/bash
PROD_STR="Simple Note System" PROD_STR="Simple Note System"
VER_STR="v2.0a8" VER_STR="v2.0a8"
YEAR=2016
cat << EOF cat << EOF
#!/bin/bash #!/bin/bash
#========================================================== #==========================================================
# $PROD_STR, $VER_STR # $PROD_STR, $VER_STR
# Copyright 2014, Xenese Labs/Sicron-Perion XNF # Copyright $YEAR, Xenese Labs/Sicron-Perion XNF
#========================================================== #==========================================================
# Prevent freak accidents involving the root directory
if [ -z "\$HOME" ]; then HOME=/home/"\$(whoami)"; fi if [ -z "\$HOME" ]; then HOME=/home/"\$(whoami)"; fi
PROD_STR="$PROD_STR" readonly PROD_STR="$PROD_STR"
readonly VER_STR="$VER_STR" readonly VER_STR="$VER_STR"
readonly ROOT_DIR="\$HOME"/.config/xenlabs/sns readonly ROOT_DIR="\$HOME"/.config/sns
readonly NOTES_DIR="\$ROOT_DIR"/notes readonly NOTES_DIR="\$ROOT_DIR"/notes
readonly TMP_DIR="\$ROOT_DIR"/tmp readonly TMP_DIR="\$ROOT_DIR"/tmp
readonly CONFIG_FILE="\$ROOT_DIR/sns.conf" readonly CONFIG_FILE="\$ROOT_DIR/sns.conf"
readonly RED_COLOR='\033[1;31m'
readonly RESET_COLOR='\033[0m'
printf "%s\n" "\$PROD_STR"
printf "%s\n" "------------------"
EOF EOF

0
nul
View File

0
null
View File

304
sns.sh
View File

@@ -1,304 +0,0 @@
#!/bin/bash
#==========================================================
# Simple Note System, v2.0a8
# Copyright 2014, Xenese Labs/Sicron-Perion XNF
#==========================================================
if [ -z "$HOME" ]; then HOME=/home/"$(whoami)"; fi
PROD_STR="Simple Note System"
readonly VER_STR="v2.0a8"
readonly ROOT_DIR="$HOME"/.config/xenlabs/sns
readonly NOTES_DIR="$ROOT_DIR"/notes
readonly TMP_DIR="$ROOT_DIR"/tmp
readonly CONFIG_FILE="$ROOT_DIR/sns.conf"
# Section: Functions
function w_conf {
if [ ! -r "$ROOT_DIR" ]; then mkdir -p "$ROOT_DIR"; fi
if [ ! -d "$TMP_DIR" ]; then mkdir -p "$TMP_DIR" ; fi
cat > "$CONFIG_FILE" << EOF
#==========================================================
# Simple Note System Config, v2.0a8
# Copyright 2014, Xenese Labs/Sicron-Perion XNF
#==========================================================
#File extension to use (for listing notes)
EXT=note
#Preferred Editor
if [ -z "$EDITOR" ]; then
EDITOR=vim
fi
#Encryption
#WARNING: ANY PREVIOUSLY UNENCRYPTED NOTES WILL BE LOST
#ENCRYPTION="TRUE"
ENCRYPTION="FALSE"
PUBKEY=""
EOF
chmod 600 "$CONFIG_FILE"
}
function pause {
read -rp " Press [Enter] to continue."
echo ""
}
function help {
echo ""
echo "usage: sns [-ce] NAME NOTEBOOK SECTION"
echo " sns [-d ] NAME NOTEBOOK SECTION"
echo " sns [-lp] NOTEBOOK"
echo " sns [-w ]"
echo " sns [-h ]"
echo ""
echo " -c | --create : Create note"
echo " -d | --delete : Delete note"
echo " -e | --edit : Open note for editing"
echo " -h | --help : Display this message"
echo " -p | --print : Print note to console"
echo " -l | --list : List all notes in NOTEBOOK"
echo " -w | --wconf : Rewrite default configuration"
echo ""
}
function p_header(){
printf "TITLE: %s\nDATE: %s\n" "$NAME" "$(date)"
}
function encrypt(){
# This function, given a recipient, $PUBKEY; a file to encrypt, $TMP_NOTE; and an
# output file, "$NOTE", will encrypt $TMP_NOTE to $NOTE against $PUBKEY's private
# GPG key.
gpg -r "$PUBKEY" -o "$NOTE" -e "$TMP_NOTE"
}
function decrypt(){
# This function, given a recipient, $PUBKEY; a file to decrypt, $TMP_NOTE; and an
# output file, "$NOTE", will decrpyt $TMP_NOTE to $NOTE against $PUBKEY's private
# GPG key.
gpg -d "$NOTE"
}
function create(){
if [ -e "$NOTE" ]; then
printf "\nERROR: Note already exists\nHint: use -e to edit the note.\n"
exit
else
mkdir -p "$NOTE_DIR"
fi
if [ -z "$ENCRYPTION" ]; then
echo "TITLE: $NAME" > "$NOTE"
echo "DATE: $(date)" >> "$NOTE"
elif [ "$ENCRYPTION" == "TRUE" ]; then
TMP_NOTE="$TMP_DIR"/"$SESSION_ID"
p_header > "$TMP_NOTE"
encrypt
fi
if [ -e "$NOTE" ]; then
echo "Created note: $NOTEBOOK/$SECTION/$NAME."
fi
}
function delete(){
if [ "$DELETE" == "TRUE" ]; then
if [ -e "$NOTE" ]; then
rm "$NOTE"
echo ""
echo "Deleted note: $NOTEBOOK/$SECTION/$NAME."
exit
else
echo ""
echo "ERROR: Note $NOTEBOOK/$SECTION/$NAME does not exist."
exit
fi
fi
}
function edit(){
if [ ! -r "$NOTE" ]; then
echo "ERROR: Note cannot be opened for editing."
exit 40;
fi
if [ "$ENCRYPTION" == "TRUE" ]; then
cp "$NOTE" "$NOTE".bk
if [ ! -d "$ROOT_DIR"/tmp ]; then mkdir "$ROOT_DIR"/tmp; fi
TMP_NOTE="$TMP_DIR/$SESSION_ID"
decrypt > "$TMP_NOTE"
else TMP_NOTE="$NOTE"; fi
if [ -z "$CREATE" ]; then printf "\nEDIT %s" "$(date)" >> "$TMP_NOTE"; fi
"$EDITOR" "$TMP_NOTE"
if [ "$ENCRYPTION" == "TRUE" ]; then
rm "$NOTE"
encrypt;
if [ -r "$NOTE" ]; then rm "$NOTE".bk; fi
fi
}
function print(){
if [ -r "$NOTE" ]; then
if [ -z "$CREATE" ]; then
if [ "$ENCRYPTION" == "TRUE" ]; then
decrypt
else
cat "$NOTE"
fi
else
printf "\nERROR: Note cannot be found.\n"
fi
fi
}
function list(){
if [ -d "$NOTES_DIR"/"$NOTEBOOK" ]; then
printf "+%s\n" "$NOTEBOOK"
find "$NOTES_DIR"/"$NOTEBOOK" -type f | while read -r NOTE; do
printf " -%s\n" "$(basename \"$NOTE\" | cut -d . -f 1 )"
done
fi
}
# End Section: Functions
###############################################################################
#==============================================================================
# Begin Main Program
#==============================================================================
###############################################################################
#==============================================================================
# Section: Configuration / Stage 1
#==============================================================================
if [ -r "$CONFIG_FILE" ]; then
source "$CONFIG_FILE"
else
create_sns_root
source "$CONFIG_FILE"
fi
if [ "$ENCRYPTION" == "TRUE" ]; then
if [ -z "$PUBKEY" ]; then
ERR_NO_KEY="TRUE"
ENCRYPTION="FALSE"
fi
command -v gpg >/dev/null 2>&1 ||\
{ ERR_NO_GPG="TRUE"; ENCRYPTION="FALSE"; }
fi
if [ "$ENCRYPTION" == "TRUE" ]; then
PROD_STR="Simple Note System (Encryption Enabled)"
if [ ! -d "$ROOT_DIR"/tmp ]; then
mkdir -p "$ROOT_DIR"/tmp
fi
fi
echo "$PROD_STR, $VER_STR"
if [ -z "$EDITOR" ]; then
>&2 echo "Error no editor specified in environment."
elif [ -n "$ERR_NO_GPG" ]; then
>&2 echo " Error: Encryption was specified, but GPG is not installed."
exit 100
elif [ -n "$ERR_NO_KEY" ]; then
>&2 echo " Error: No GPG recipient was provided in $CONFIG_FILE. "
exit 110
fi
#==============================================================================
# End Section: Configuration / Stage 1
#==============================================================================
#==============================================================================
# Section: Argument Parsing / Stage 2
#==============================================================================
NAME=""
NOTEBOOK=""
SECTION=""
if [ -z "$1" ]; then help; exit 20
else
ARGS=( "$@" )
for ARG in "${ARGS[@]}"; do
if [ "$ARG" = "-c" ] || [ "$ARG" = "--create" ]; then CREATE="TRUE"
elif [ "$ARG" = "-d" ] || [ "$ARG" = "--delete" ]; then DELETE="TRUE"
elif [ "$ARG" = "-e" ] || [ "$ARG" = "--edit" ]; then EDIT="TRUE"
elif [ "$ARG" = "-ce" ] || [ "$ARG" = "-ec" ]; then EDIT="TRUE"; CREATE="TRUE"
elif [ "$ARG" = "-p" ] || [ "$ARG" = "--print" ]; then PRINT="TRUE"
elif [ "$ARG" = "-l" ] || [ "$ARG" = "--list" ]; then LIST="TRUE"
elif [ "$ARG" = "-h" ] || [ "$ARG" == "--help" ]; then help; exit 0
elif [ "$ARG" = "-w" ] || [ "$ARG" == "--wconf" ]; then create_sns_root; exit 0
else
if [ -z "$NAME" ] && [ -n "$ARG" ]; then NAME="$ARG"
elif [ -z "$NOTEBOOK" ] && [ -n "$ARG" ]; then NOTEBOOK="$ARG"
elif [ -z "$SECTION" ] && [ -n "$ARG" ]; then SECTION="$ARG"
fi
fi
done
if [ -n "$NAME" ] && [ -z "$NOTEBOOK" ] && [ -n "$LIST" ]; then
# If we got a note title above, but no notebook, and the list option
# was specified, we assume that the detected note title is actually a
# notebook name.
NOTEBOOK="$NAME"
NAME=""
fi
fi
# Note: w_conf and help have highest priority, as they are the only functions
# that can work without any arguments.
#==============================================================================
# End Section: Argument Parsing / Stage 2
#==============================================================================
#==============================================================================
# Section: Actions / Stage 3
#==============================================================================
# List only requires a notebook, and is exclusive.
if [ -z "$NOTEBOOK" ]; then
echo " ERROR: Insufficient arguments:"
echo " Notebook not specified"
exit 30
fi
if [ -n "$LIST" ]; then
list
exit 0
fi
#All other functions require a note title and notebook.
if [ -z "$NAME" ]; then
echo " ERROR: Insufficient arguments:"
echo " Title not specified"
exit 30
fi
SESSION_ID="$RANDOM"
NOTE_DIR="$NOTES_DIR"/"$NOTEBOOK"/"$SECTION"/
if [ "$ENCRYPTION" == "TRUE" ]; then readonly NOTE="$NOTE_DIR""$NAME"."$EXT".gpg
else readonly NOTE="$NOTE_DIR""$NAME"."$EXT"
fi
if [ "$PRINT" == "TRUE" ]; then print; exit 0; fi
if [ "$DELETE" == "TRUE" ]; then delete; exit 0; fi
if [ "$CREATE" == "TRUE" ]; then create; fi
if [ "$EDIT" == "TRUE" ]; then edit; fi
#==============================================================================
# End Section: Actions / Stage 3
#==============================================================================

10
sns.xcodeproj/project.pbxproj
View File

@@ -15,11 +15,12 @@
5D22D6A81AFC4F5A0036DC52 /* p_header.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = p_header.sh; sourceTree = "<group>"; }; 5D22D6A81AFC4F5A0036DC52 /* p_header.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = p_header.sh; sourceTree = "<group>"; };
5D22D6A91AFC4F5A0036DC52 /* pause.sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = pause.sns.sh; sourceTree = "<group>"; }; 5D22D6A91AFC4F5A0036DC52 /* pause.sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = pause.sns.sh; sourceTree = "<group>"; };
5D22D6AA1AFC4F5A0036DC52 /* print.sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = print.sns.sh; sourceTree = "<group>"; }; 5D22D6AA1AFC4F5A0036DC52 /* print.sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = print.sns.sh; sourceTree = "<group>"; };
5D22D6AB1AFC4F5A0036DC52 /* create_sns_root.sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = create_sns_root.sns.sh; sourceTree = "<group>"; }; 5D22D6AB1AFC4F5A0036DC52 /* init_store.sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = init_store.sns.sh; sourceTree = "<group>"; };
5D22D6AD1AFC4F5A0036DC52 /* stage1.sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = stage1.sns.sh; sourceTree = "<group>"; }; 5D22D6AD1AFC4F5A0036DC52 /* stage1.sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = stage1.sns.sh; sourceTree = "<group>"; };
5D22D6AE1AFC4F5A0036DC52 /* stage2.sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = stage2.sns.sh; sourceTree = "<group>"; }; 5D22D6AE1AFC4F5A0036DC52 /* stage2.sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = stage2.sns.sh; sourceTree = "<group>"; };
5D22D6AF1AFC4F5A0036DC52 /* stage3.sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = stage3.sns.sh; sourceTree = "<group>"; }; 5D22D6AF1AFC4F5A0036DC52 /* stage3.sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = stage3.sns.sh; sourceTree = "<group>"; };
5D22D6B01AFC5B100036DC52 /* libencryption.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = libencryption.sh; sourceTree = "<group>"; }; 5D22D6B01AFC5B100036DC52 /* libencryption.sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = libencryption.sns.sh; sourceTree = "<group>"; };
5D75D24F1C5F13DF001E7B33 /* verify_store.sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = verify_store.sns.sh; sourceTree = "<group>"; };
5D7E611F1AB74D33001D49B9 /* build.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = build.sh; sourceTree = "<group>"; }; 5D7E611F1AB74D33001D49B9 /* build.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = build.sh; sourceTree = "<group>"; };
5D7E91FB1B27FB620030B30D /* header.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = header.sh; sourceTree = "<group>"; }; 5D7E91FB1B27FB620030B30D /* header.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = header.sh; sourceTree = "<group>"; };
5DE839831AB9DACE006CB4F6 /* sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = sns.sh; sourceTree = "<group>"; }; 5DE839831AB9DACE006CB4F6 /* sns.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = sns.sh; sourceTree = "<group>"; };
@@ -47,8 +48,9 @@
5D22D6A81AFC4F5A0036DC52 /* p_header.sh */, 5D22D6A81AFC4F5A0036DC52 /* p_header.sh */,
5D22D6A91AFC4F5A0036DC52 /* pause.sns.sh */, 5D22D6A91AFC4F5A0036DC52 /* pause.sns.sh */,
5D22D6AA1AFC4F5A0036DC52 /* print.sns.sh */, 5D22D6AA1AFC4F5A0036DC52 /* print.sns.sh */,
5D22D6AB1AFC4F5A0036DC52 /* create_sns_root.sns.sh */, 5D22D6AB1AFC4F5A0036DC52 /* init_store.sns.sh */,
5D22D6B01AFC5B100036DC52 /* libencryption.sh */, 5D22D6B01AFC5B100036DC52 /* libencryption.sns.sh */,
5D75D24F1C5F13DF001E7B33 /* verify_store.sns.sh */,
); );
path = includes; path = includes;
sourceTree = "<group>"; sourceTree = "<group>";

BIN
sns.xcodeproj/project.xcworkspace/xcuserdata/xilmwa.xcuserdatad/UserInterfaceState.xcuserstate generated
View File

Binary file not shown.

316
sns1.sh
View File

@@ -1,316 +0,0 @@
#!/bin/bash
#==========================================================
# Simple Note System, v1.1
# Copyright 2014, Xenese Labs/Sicron-Perion XNF
#==========================================================
PROD_STR="Simple Note System"
VER_STR=v1.1
#==============================================================================
# Section: Helper Functions
#==============================================================================
function writeconf {
cat > $HOME/.sns << EOF
#==========================================================
# Simple Note System Config, v1.1
# Copyright 2014, Xenese Labs/Sicron-Perion XNF
#==========================================================
#Directory where notes will be stored
BASEDIR=$HOME/notes
#File extension to use (for listing notes)
EXT=note
#Preferred Editor
EDITOR=vim
#Encryption
#WARNING: ANY PREVIOUSLY UNENCRYPTED NOTES WILL BE LOST
ENCRYPTION="FALSE"
ENC_KEY=""
EOF
chmod 600 $HOME/.sns
}
function help {
echo ""
echo "usage: sns [-ce] NAME NOTEBOOK SECTION"
echo " sns [-d ] NAME NOTEBOOK SECTION"
echo " sns [-l ] NOTEBOOK"
echo " sns [-w ]"
echo ""
echo " -c | --create : Create note"
echo " -d | --delete : Delete note"
echo " -e | --edit : Open note for editing"
echo " -p | --print : Print note to console"
echo " -l | --list : List all notes in NOTEBOOK"
echo " -w | --wconf : Write default configuration to ~/.sns (useful for Encryption)"
echo ""
}
function pause {
read -p " Press [Enter] to continue."
echo ""
}
#==============================================================================
# End Section: Helper Functions
#==============================================================================
#==============================================================================
# Section: Configuration
#==============================================================================
if [ -r $HOME/.sns ]; then
source $HOME/.sns
else
BASEDIR=$HOME/notes
EDITOR=vim
EXT=note
fi
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
if [ "$ENCRYPTION" == "TRUE" ]; then
PROD_STR="Simple Note System (Encryption Enabled)"
EXT="$EXT.enc"
if [ ! -d ~/.tmp ]; then
mkdir -p ~/.tmp
fi
fi
echo "$PROD_STR, $VER_STR"
if [ -n "$ERR_NO_SSL" ]; then
echo >&2 " Warning: OpenSSL not installed. Encryption disabled."
fi
if [ -n "$ERR_NO_KEY" ]; then
echo " Warning: No encryption key was provided. Encryption disabled."
fi
if [ -n "$ERR_NO_SSL" -o -n "$ERR_NO_KEY" ]; then
pause
fi
#==============================================================================
# End Section: Read Configuration
#==============================================================================
#==============================================================================
# Section: Argument Parsing
#==============================================================================
NAME=""
NOTEBOOK=""
SECTION=""
if [ -z "$1" ]; then #If no input was given, print help
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
fi
#==============================================================================
# End Section: Argument Parsing
#==============================================================================
#==============================================================================
# Section: Main
#==============================================================================
NOTEDIR=$BASEDIR/$NOTEBOOK/$SECTION/
NOTE=$NOTEDIR$NAME.$EXT
if [ "$ENCRYPTION" == "TRUE" ]; then
NOTE=$NOTE.tmp
fi
#==========================================================================
# Subection: List
#==========================================================================
if [ -n "$LIST" ]; then
NOTEBOOK="$NAME" #In case of a list command, arg parsing fails.
if [ -z "$NOTEBOOK" ]; then
echo " ERROR: Insufficient arguments"
help
exit
else
if [ -d "$BASEDIR"/"$NOTEBOOK" ]; then
echo ""
printf "Notes in $(basename $NOTEBOOK):"
echo ""
NOTES=( $(find $BASEDIR/$NOTEBOOK -name "*.$EXT" -print0 | sed s:$BASEDIR/$NOTEBOOK/:" ":g | sed -e s:".$EXT"::g | tr "/" " ") )
let i=0
for NOTE in ${NOTES[@]}; do
if [ -d $BASEDIR/$NOTEBOOK/$NOTE ]; then
if [ "$LAST_SECTION" != "$NOTE" ]; then
printf " Section: $NOTE\n"
fi
LAST_SECTION=$NOTE
else
#if [ $(($i % 1)) -eq 0 ]; then
# printf "\n "
#fi
printf " $NOTE\n"
fi
let i++
done
printf "\n"
else
echo ""
echo "ERROR: Notebook $NOTEBOOK does not exist."
echo ""
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

43
src/includes/create.sns.sh
View File

@@ -1,22 +1,35 @@
function create(){ function create(){
if [ -e "$NOTE" ]; then # Depends : p_header
printf "\nERROR: Note already exists\nHint: use -e to edit the note.\n" # Requires: $NOTE, $NOTE_DIR,
exit # Optional: $ENCRYPTION, $SESSION_ID, $TMP_DIR encrypt
else # Given a valid setup, create writes the standard note header as specified
mkdir -p "$NOTE_DIR" # by p_header, to $NOTE.
# Refuse to overwrite a note
if [ -e "$NOTE_DIR/$NOTE" ]; then
printf " $RED_COLOR!$RESET_COLOR %s\n\t%s\n"\
"Note already exists"\
"Hint: use -e to edit the note."
exit 200
fi fi
if [ -z "$ENCRYPTION" ]; then # If the note's notebook/section does not exist,
echo "TITLE: $NAME" > "$NOTE" # create the appropriate folders.
echo "DATE: $(date)" >> "$NOTE" mkdir -p "$NOTE_DIR"/$(dirname "$NOTE")
elif [ "$ENCRYPTION" == "TRUE" ]; then
# Write the standard note header
if [ "$ENCRYPTION" == "TRUE" ]; then
TMP_NOTE="$TMP_DIR"/"$SESSION_ID" TMP_NOTE="$TMP_DIR"/"$SESSION_ID"
p_header > "$TMP_NOTE" p_header > "$TMP_NOTE"
encrypt encrypt
fi else
p_header > "$NOTE_DIR/$NOTE"
if [ -e "$NOTE" ]; then fi
echo "Created note: $NOTEBOOK/$SECTION/$NAME." # Make sure the note exists, and inform the user of the result.
fi if [ -e "$NOTE_DIR/$NOTE" ]; then
printf " - %s\n" "Created note: ${NOTE%.*}"
else
printf " $RED_COLOR!$RESET_COLOR%s\n"\
"Something went wrong, and the note was not created."
fi
} }

31
src/includes/create_sns_root.sns.sh
View File

@@ -1,31 +0,0 @@
function w_conf {
if [ ! -r "$ROOT_DIR" ]; then mkdir -p "$ROOT_DIR"; fi
if [ ! -d "$TMP_DIR" ]; then mkdir -p "$TMP_DIR" ; fi
cat > "$CONFIG_FILE" << EOF
#==========================================================
# Simple Note System Config, v2.0a8
# Copyright 2014, Xenese Labs/Sicron-Perion XNF
#==========================================================
#File extension to use (for listing notes)
EXT=note
#Preferred Editor
if [ -z "$EDITOR" ]; then
EDITOR=vim
fi
#Encryption
#WARNING: ANY PREVIOUSLY UNENCRYPTED NOTES WILL BE LOST
#ENCRYPTION="TRUE"
ENCRYPTION="FALSE"
PUBKEY=""
EOF
chmod 600 "$CONFIG_FILE"
}

21
src/includes/delete.sns.sh
View File

@@ -1,14 +1,11 @@
function delete(){ function delete(){
if [ "$DELETE" == "TRUE" ]; then # Requires: $NOTE, $NOTE_DIR
if [ -e "$NOTE" ]; then # Given a valid $NOTE, delete removes $NOTE from sns.
rm "$NOTE"
echo "" if [ -e "$NOTE_DIR/$NOTE" ]; then
echo "Deleted note: $NOTEBOOK/$SECTION/$NAME." rm "$NOTE_DIR/$NOTE"
exit printf " - %s\n" "Deleted note: ${NOTE%.*}."
else else
echo "" printf " $RED_COLOR!$RESET_COLOR %s\n" "Note ${NOTE%.*} does not exist."
echo "ERROR: Note $NOTEBOOK/$SECTION/$NAME does not exist." fi
exit
fi
fi
} }

16
src/includes/edit.sns.sh
View File

@@ -1,12 +1,20 @@
function edit(){ function edit(){
if [ ! -r "$NOTE" ]; then # Requires: $EDITOR, $NOTE
# Optional: $ENCRYPTION, $TMP_DIR, $SESSION_ID, decrypt, encrypt
# Verify an editor was specified
if [ -z "$EDITOR" ]; then
>&2 echo "Error no editor specified in environment."
exit
# Verify the note exists
elif [ ! -r "$NOTE" ]; then
echo "ERROR: Note cannot be opened for editing." echo "ERROR: Note cannot be opened for editing."
exit 40; exit 40;
fi fi
# When encryption is enabled, decrypt $NOTE to a temp file
if [ "$ENCRYPTION" == "TRUE" ]; then if [ "$ENCRYPTION" == "TRUE" ]; then
cp "$NOTE" "$NOTE".bk cp "$NOTE" "$NOTE".bk #Insurance
if [ ! -d "$ROOT_DIR"/tmp ]; then mkdir "$ROOT_DIR"/tmp; fi if [ ! -d "$TMP_DIR" ]; then mkdir "$TMP_DIR"; fi
TMP_NOTE="$TMP_DIR/$SESSION_ID" TMP_NOTE="$TMP_DIR/$SESSION_ID"
decrypt > "$TMP_NOTE" decrypt > "$TMP_NOTE"
else TMP_NOTE="$NOTE"; fi else TMP_NOTE="$NOTE"; fi

26
src/includes/help.sns.sh
View File

@@ -1,18 +1,14 @@
function help { function help {
echo "" printf "\n%s" "usage: sns [-cedp] NAME NOTEBOOK SECTION"
echo "usage: sns [-ce] NAME NOTEBOOK SECTION" printf "\n%s" " sns [-l] NOTEBOOK"
echo " sns [-d ] NAME NOTEBOOK SECTION" printf "\n%s" " sns [-hi ]"
echo " sns [-lp] NOTEBOOK"
echo " sns [-w ]"
echo " sns [-h ]"
echo "" printf "\n%s" " -c | --create : Create note"
echo " -c | --create : Create note" printf "\n%s" " -d | --delete : Delete note"
echo " -d | --delete : Delete note" printf "\n%s" " -e | --edit : Open note for editing"
echo " -e | --edit : Open note for editing" printf "\n%s" " -h | --help : Display this message"
echo " -h | --help : Display this message" printf "\n%s" " -p | --print : Print note to console"
echo " -p | --print : Print note to console" printf "\n%s" " -l | --list : List all notes in NOTEBOOK"
echo " -l | --list : List all notes in NOTEBOOK" printf "\n%s" " -i | --init : Write default config and initalize SNS store"
echo " -w | --wconf : Rewrite default configuration" printf "\n"
echo ""
} }

34
src/includes/init_store.sns.sh Normal file
View File

@@ -0,0 +1,34 @@
function init_store {
if [ ! -d "$ROOT_DIR" ]; then mkdir -p "$ROOT_DIR"; WILL_INIT="TRUE"; fi
if [ ! -d "$TMP_DIR" ]; then mkdir -p "$TMP_DIR" ; WILL_INIT="TRUE"; fi
cat > "$CONFIG_FILE" << EOF
# This file contains directives for the Simple Note System.
EXT=note # File extension to use (for listing notes)
#EDITOR= # Preferred Editor:
# If you would like to specify a different editor for
# sns to use, you may do so here.
ENCRYPTION="FALSE" # Main Encryption Toggle:
# WARNING: ANY PREVIOUSLY UNENCRYPTED NOTES WILL BE LOST
# Change this to TRUE to enable encryption.
PUBKEY="" # Public Key
# Encryption is done using GPG. You must enter your
# public key's identifier here.
EOF
chmod 600 "$CONFIG_FILE"
printf "\n - %s\n" "Rewrote Default Configuration"
if [ "$WILL_INIT" == "TRUE" ]; then
printf " - %s %s\n" "Environment initialized in" "$ROOT_DIR"
else
printf " - %s\n" "Store already initialized."
fi
}

0
src/includes/libencryption.sh → src/includes/libencryption.sns.sh
View File

7
src/includes/verify_store.sns.sh Normal file
View File

@@ -0,0 +1,7 @@
function verify_store {
ETC_DIR=$(dirname "$CONFIG_FILE")
STORE_DIRS=("$ROOT_DIR" "$NOTES_DIR" "$TMP_DIR" "$ETC_DIR")
for DIR in "${STORE_DIRS[@]}"; do
mkdir -p "$DIR"
done
}

20
src/main/stage1.sns.sh
View File

@@ -1,13 +1,16 @@
#============================================================================== #==============================================================================
# Section: Configuration / Stage 1 # Stage 1: Read Configuration / Verify Integrity
#============================================================================== #==============================================================================
if [ -r "$CONFIG_FILE" ]; then if [ -r "$CONFIG_FILE" ]; then
source "$CONFIG_FILE" source "$CONFIG_FILE"
else else
create_sns_root init_store
source "$CONFIG_FILE" source "$CONFIG_FILE"
fi fi
verify_store
if [ "$ENCRYPTION" == "TRUE" ]; then if [ "$ENCRYPTION" == "TRUE" ]; then
if [ -z "$PUBKEY" ]; then if [ -z "$PUBKEY" ]; then
ERR_NO_KEY="TRUE" ERR_NO_KEY="TRUE"
@@ -19,26 +22,15 @@ if [ "$ENCRYPTION" == "TRUE" ]; then
fi fi
if [ "$ENCRYPTION" == "TRUE" ]; then if [ "$ENCRYPTION" == "TRUE" ]; then
PROD_STR="Simple Note System (Encryption Enabled)"
if [ ! -d "$ROOT_DIR"/tmp ]; then if [ ! -d "$ROOT_DIR"/tmp ]; then
mkdir -p "$ROOT_DIR"/tmp mkdir -p "$ROOT_DIR"/tmp
fi fi
fi fi
echo "$PROD_STR, $VER_STR" if [ -n "$ERR_NO_GPG" ]; then
if [ -z "$EDITOR" ]; then
>&2 echo "Error no editor specified in environment."
elif [ -n "$ERR_NO_GPG" ]; then
>&2 echo " Error: Encryption was specified, but GPG is not installed." >&2 echo " Error: Encryption was specified, but GPG is not installed."
exit 100 exit 100
elif [ -n "$ERR_NO_KEY" ]; then elif [ -n "$ERR_NO_KEY" ]; then
>&2 echo " Error: No GPG recipient was provided in $CONFIG_FILE. " >&2 echo " Error: No GPG recipient was provided in $CONFIG_FILE. "
exit 110 exit 110
fi fi
#==============================================================================
# End Section: Configuration / Stage 1
#==============================================================================

86
src/main/stage2.sns.sh
View File

@@ -1,41 +1,57 @@
#============================================================================== #==============================================================================
# Section: Argument Parsing / Stage 2 # Stage 2: Argument Parsing
#============================================================================== #==============================================================================
NOTE=""
NAME=""
NOTEBOOK=""
SECTION=""
if [ -z "$1" ]; then help; exit 20 if [ -z "$1" ]; then help; exit 20
else else
ARGS=( "$@" ) for ARG in "$@"; do
for ARG in "${ARGS[@]}"; do case "$ARG" in
if [ "$ARG" = "-c" ] || [ "$ARG" = "--create" ]; then CREATE="TRUE" -c|--create)
elif [ "$ARG" = "-d" ] || [ "$ARG" = "--delete" ]; then DELETE="TRUE" CREATE="TRUE"
elif [ "$ARG" = "-e" ] || [ "$ARG" = "--edit" ]; then EDIT="TRUE" OP="TRUE"
elif [ "$ARG" = "-ce" ] || [ "$ARG" = "-ec" ]; then EDIT="TRUE"; CREATE="TRUE" ;;
elif [ "$ARG" = "-p" ] || [ "$ARG" = "--print" ]; then PRINT="TRUE" -d|--delete)
elif [ "$ARG" = "-l" ] || [ "$ARG" = "--list" ]; then LIST="TRUE" DELETE="TRUE"
elif [ "$ARG" = "-h" ] || [ "$ARG" == "--help" ]; then help; exit 0 OP="TRUE"
elif [ "$ARG" = "-w" ] || [ "$ARG" == "--wconf" ]; then create_sns_root; exit 0 ;;
else -e|--edit)
if [ -z "$NAME" ] && [ -n "$ARG" ]; then NAME="$ARG" EDIT="TRUE"
elif [ -z "$NOTEBOOK" ] && [ -n "$ARG" ]; then NOTEBOOK="$ARG" OP="TRUE"
elif [ -z "$SECTION" ] && [ -n "$ARG" ]; then SECTION="$ARG" ;;
fi -ce|-ec)
fi CREATE="TRUE"
done EDIT="TRUE"
if [ -n "$NAME" ] && [ -z "$NOTEBOOK" ] && [ -n "$LIST" ]; then OP="TRUE"
# If we got a note title above, but no notebook, and the list option ;;
# was specified, we assume that the detected note title is actually a -l|--list)
# notebook name. LIST="TRUE"
NOTEBOOK="$NAME" OP="TRUE"
NAME="" ;;
fi -p|--print)
PRINT="TRUE"
OP="TRUE"
;;
-h|--help)
help
exit 0
;;
-i|--init-store)
init_store
exit 0
;;
*)
NOTE="$ARG"
break;
;;
esac
done
if [ -n "$NAME" ] && [ -z "$NOTEBOOK" ] && [ -n "$LIST" ]; then
# If a note title was specified, but no notebook, and the list option
# was specified, assume that the detected note title is actually the
# name of a notebook
NOTEBOOK="$NAME"
NAME=""
fi
fi fi
# Note: w_conf and help have highest priority, as they are the only functions # w_conf and help are called here to avoid excess stage 3 code.
# that can work without any arguments.
#==============================================================================
# End Section: Argument Parsing / Stage 2
#==============================================================================

48
src/main/stage3.sns.sh
View File

@@ -1,38 +1,32 @@
#============================================================================== #==============================================================================
# Section: Actions / Stage 3 # Section: Actions / Stage 3
#============================================================================== #==============================================================================
# List only requires a notebook, and is exclusive. # Default behavior
if [ -z "$NOTEBOOK" ]; then # If no operation was specified, print help and exit on ERR_NO_OP
echo " ERROR: Insufficient arguments:" if [ "$OP" != "TRUE" ]; then
echo " Notebook not specified" help; exit 20
fi
# All options not requiring a note to be specified have been dealt
# with; if one isn't specified, exit on ERR_NO_NOTE.
if [ -z "$NOTE" ]; then
printf " $RED_COLOR!$RESET_COLOR %s\n" "No note specified."
exit 30 exit 30
fi fi
if [ -n "$LIST" ]; then NOTE_DIR="$NOTES_DIR"/"$NOTEBOOK"/"$SECTION"
list
exit 0 if [ "$ENCRYPTION" == "TRUE" ]; then
SESSION_ID="$RANDOM" #SESSION_ID later becomes the temporary filename
readonly NOTE="$NOTE.$EXT.gpg"
else
readonly NOTE="$NOTE.$EXT"
fi fi
#All other functions require a note title and notebook. if [ "$LIST" == "TRUE" ]; then list; exit 0; fi
if [ "$PRINT" == "TRUE" ]; then print; exit 0; fi
if [ -z "$NAME" ]; then if [ "$DELETE" == "TRUE" ]; then delete; exit 0; fi
echo " ERROR: Insufficient arguments:" if [ "$CREATE" == "TRUE" ]; then create; fi
echo " Title not specified" if [ "$EDIT" == "TRUE" ]; then edit; fi
exit 30
fi
SESSION_ID="$RANDOM"
NOTE_DIR="$NOTES_DIR"/"$NOTEBOOK"/"$SECTION"/
if [ "$ENCRYPTION" == "TRUE" ]; then readonly NOTE="$NOTE_DIR""$NAME"."$EXT".gpg
else readonly NOTE="$NOTE_DIR""$NAME"."$EXT"
fi
if [ "$PRINT" == "TRUE" ]; then print; exit 0; fi
if [ "$DELETE" == "TRUE" ]; then delete; exit 0; fi
if [ "$CREATE" == "TRUE" ]; then create; fi
if [ "$EDIT" == "TRUE" ]; then edit; fi
#============================================================================== #==============================================================================
# End Section: Actions / Stage 3 # End Section: Actions / Stage 3