diff --git a/build/bash-completion b/build/bash-completion deleted file mode 100644 index f7d0cc9..0000000 --- a/build/bash-completion +++ /dev/null @@ -1,99 +0,0 @@ -#!/bin/bash -# Simple Note System, bash completion file -# ======================================== -# Copyright (C) 2016, Jon Lewis -# Simple Note System is licensed under the GPLv2. Please see LICENSE for more -# information. -# -# **Notice** -# This file was adapted from pass, the standard unix password manager under the -# terms of the GPLv2 license. Pass may be found at https://passwordstore.org. -# -# The original file bore the following copyright notice: -# -# Copyright (C) 2012 - 2014 Jason A. Donenfeld and -# Brian Mattern . All Rights Reserved. -# This file is licensed under the GPLv2+. Please see COPYING for more information. - -if [ -r "$HOME"/.local/sns/sns.conf ]; then source "$HOME"/.local/sns/sns.conf; fi - -_sns_complete_entries () { - prefix="${SNS_STORE_DIR:-$HOME/.local/sns/notes/}" - suffix=".note" - autoexpand=${1:-0} - - local IFS=$'\n' - local items=($(compgen -f $prefix$cur)) - for item in "${items[@]}"; do - [[ $item =~ /\.[^/]*$ ]] && continue - - # if there is a unique match, and it is a directory with one entry - # autocomplete the subentry as well (recursively) - if [[ ${#items[@]} -eq 1 && $autoexpand -eq 1 ]]; then - while [[ -d $item ]]; do - local subitems=($(compgen -f "$item/")) - local filtereditems=( ) - for item2 in "${subitems[@]}"; do - [[ $item2 =~ /\.[^/]*$ ]] && continue - filtereditems+=( "$item2" ) - done - if [[ ${#filtereditems[@]} -eq 1 ]]; then - item="${filtereditems[0]}" - else - break - fi - done - fi - - # append / to directories - [[ -d $item ]] && item="$item/" - - item="${item%$suffix}" - item="${item%.gpg}" - COMPREPLY+=("${item#$prefix}") - done -} - -_sns_complete_folders () { - prefix="${SNS_STORE_DIR:-$HOME/.local/sns/notes/}" - - local IFS=$'\n' - local items=($(compgen -d $prefix$cur)) - for item in "${items[@]}"; do - [[ $item == $prefix.* ]] && continue - COMPREPLY+=("${item#$prefix}/") - done -} - -_sns_complete_keys () { - local IFS=$'\n' - # Extract names and email addresses from gpg --list-keys - local keys="$(gpg2 --list-keys --with-colons | cut -d : -f 10 | sort -u | sed '/^$/d')" - COMPREPLY+=($(compgen -W "${keys}" -- ${cur})) -} - -_sns() -{ - COMPREPLY=() - local cur="${COMP_WORDS[COMP_CWORD]}" - local commands="--create --config --delete --edit --help --print --list --init\ - -c "$VCTL" -d -e -h -p -l -i" - if [[ $COMP_CWORD -gt 1 ]]; then - local lastarg="${COMP_WORDS[$COMP_CWORD-1]}" - case "${COMP_WORDS[1]}" in - --list|-l) - _sns_complete_folders - ;; - --edit|-e|--print|-p|--delete|-d) - _sns_complete_entries - ;; - *) - ;; - esac - else - COMPREPLY+=($(compgen -W "${commands}" -- ${cur})) - - fi -} - -complete -o filenames -o nospace -F _sns sns diff --git a/build/sns b/build/sns deleted file mode 100755 index 82a844b..0000000 --- a/build/sns +++ /dev/null @@ -1,448 +0,0 @@ -#!/bin/bash -# Simple Note System -# Copyright (C) 2016, Jon Lewis -# -# This program is free software; you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation; either version 2 of the License, or -# (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License along -# with this program; if not, write to the Free Software Foundation, Inc., -# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. - -# Prevent freak accidents involving the root directory -if [ -z "$HOME" ]; then HOME=/home/"$(whoami)"; fi - -# Store files and locations -readonly PROD_STR="Simple Note System" -readonly VER_STR="v2.0a12" -readonly ROOT_DIR="$HOME"/.local/sns -readonly NOTES_DIR="$ROOT_DIR"/notes -readonly TMP_DIR="$ROOT_DIR"/tmp -readonly CONFIG_FILE="$ROOT_DIR/sns.conf" - -#Color codes for messages -readonly RED_COLOR='\033[1;31m' -readonly YELLOW_COLOR='\033[1;33m' -readonly RESET_COLOR='\033[0m' - -#Print the program header to stdout -printf "%s\n" "$PROD_STR" -printf "%s\n" "------------------" -# Section: Functions -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 "$NOTES_DIR/$NOTE" -e "$TMP_NOTE" - -} - -function decrypt(){ -# This function, given a file to decrypt, will attempt to decrypt the file -# against the specified recipient's private key, and print the result to -# stdout. - gpg -d "$NOTES_DIR/$NOTE" -} -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 -if [ ! -d "$NOTES_DIR" ]; then mkdir -p "$NOTES_DIR"; fi - -if [ ! -r "$CONFIG_FILE" ]; then -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, otherwise, sns will - # use the editor specified in the environment. - -DATE_FMT="+%D %T" # Date Format: - # If you would like to modify the date format, you may - # specify one appropriate to the \`date\` command. - -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. - -#VCTL="" # Version Control Program - # Set this to the name of your preferred version control - # program to use it in SNS. Examples: git, hg, svn -EOF -chmod 600 "$CONFIG_FILE" -printf "%s\n" "- Rewrote Default Configuration" -else - printf "$RED_COLOR!$RESET_COLOR - %s" "Refusing to overwrite existing config" -fi - -if [ "$WILL_INIT" == "TRUE" ]; then - printf "%s\n" "- Store initialized in $ROOT_DIR" -else - printf "%s\n" "- Store already initialized." -fi -} -function verify_store { - - ETC_DIR=$(dirname "$CONFIG_FILE") - - STORE_DIRS=("$ROOT_DIR" "$NOTES_DIR" "$TMP_DIR" "$ETC_DIR") - for DIR in "${STORE_DIRS[@]}"; do - if [ ! -d "$DIR" ]; then - mkdir -p "$DIR" - fi - done -} -function verctl { - "$@" - if [ $2 == "init" ]; then - "$VCTL" add . - "$VCTL" commit -m "Initial Commit" - fi -} -function create(){ - # Depends : p_header - # Requires: $NOTE, $NOTE_DIR, - # Optional: $ENCRYPTION, $SESSION_ID, $TMP_DIR encrypt - # Given a valid setup, create writes the standard note header as specified - # by p_header, to $NOTE. - - # Refuse to overwrite a note - if [ -e "$NOTES_DIR/$NOTE" ]; then - >&2 printf "$RED_COLOR!$RESET_COLOR %s\n\t%s\n"\ - "Note already exists"\ - "Hint: use -e to edit the note." - exit 200 - fi - - # If the note's notebook/section does not exist, - # create the appropriate folders. - mkdir -p "$NOTES_DIR"/"$(dirname "$NOTE")" - - # Write the standard note header - if [ "$ENCRYPTION" == "TRUE" ]; then - TMP_NOTE="$TMP_DIR"/"$SESSION_ID" - p_header > "$TMP_NOTE" - encrypt - else - p_header > "$NOTES_DIR/$NOTE" - fi - # Make sure the note exists, and inform the user of the result. - if [ -e "$NOTES_DIR/$NOTE" ]; then - printf "%s\n" "- Created note: ${NOTE%.*}" - else - >&2 printf "$RED_COLOR!$RESET_COLOR %s\n"\ - "Something went wrong, and the note was not created." - fi -} -function delete(){ - # Requires: $NOTE, $NOTE_DIR - # Given a valid $NOTE, delete removes $NOTE from sns. - - if [ -e "$NOTES_DIR/$NOTE" ]; then - printf "$RED_COLOR!!$RESET_COLOR %s%s" "Delete " "${NOTE%.*}" - read -p " (y/N) " YN - case "$YN" in - Y|y) - rm "$NOTES_DIR/$NOTE" - printf "%s\n" "- Deleted note: ${NOTE%.*}." - ;; - *) - printf "%s\n" "Aborted." - ;; - esac - #Cleanup empty notebooks/sections] - find "$NOTES_DIR" -mindepth 1 -type d | tac |\ - while read -r DIR ; do - if [ ! "$(ls -A "$DIR")" ]; then - rmdir "$DIR" - fi - done - else - >&2 printf "$RED_COLOR!$RESET_COLOR %s\n" "Note ${NOTE%.*} does not exist." - fi -} -function edit(){ -# Requires: $EDITOR, $NOTE -# Optional: $ENCRYPTION, $TMP_DIR, $SESSION_ID, decrypt, encrypt - -# Verify an editor was specified -if [ -z "$EDITOR" ]; then - >&2 printf "$RED_COLOR!$RESET_COLOR %s\n"\ - "No editor specified in environment." - exit -# Verify the note exists -elif [ ! -r "$NOTES_DIR/$NOTE" ]; then - >&2 printf "$RED_COLOR!$RESET_COLOR %s\n"\ - "Note cannot be opened for editing." - exit 40; -fi - -# If encryption is enabled, decrypt $NOTE to a temp file, otherwise -# operate on the note directly. -if [ "$ENCRYPTION" == "TRUE" ]; then - cp "$NOTES_DIR/$NOTE" "$NOTES_DIR/$NOTE.bk" #Insurance - TMP_NOTE="$TMP_DIR/$SESSION_ID" - decrypt > "$TMP_NOTE" -else - TMP_NOTE="$NOTES_DIR/$NOTE"; -fi - -# Write an ammendment header -if [ -z "$CREATE" ]; then - printf "\n%s\n" "edit - $(date "$DATE_FMT")" >> "$TMP_NOTE" - printf "%s\n" "===================================" >> "$TMP_NOTE" -fi - -# Call the editor -printf "%s\n" "- editing ${NOTE%.*}" -"$EDITOR" "$TMP_NOTE" - -# If the file was previously decrypted, encrypt it back -if [ "$ENCRYPTION" == "TRUE" ]; then - printf "%s\n" "- encrypting ${NOTE%.*}" - rm "$NOTES_DIR/$NOTE" - encrypt; - rm "$TMP_NOTE" - if [ ! -r "$NOTES_DIR/$NOTE" ]; then - >&2 printf "$RED_COLOR!$RESET_COLOR %s\n" "error: note was not saved." - cp "$NOTES_DIR/$NOTE.bk" "$NOTES_DIR/$NOTE" - else - rm "$NOTES_DIR/$NOTE.bk"; - fi -fi - -# If $VCTL is defined, add the edited note to the repo. -if [ "$VCTL" ]; then - >&2 printf "%s %s %s\n" "- adding to" "$VCTL" "repo". - verctl "$VCTL" add ""$NOTES_DIR"/$NOTE" - verctl "$VCTL" commit -m "Added/Changed $NOTE" > /dev/null -fi -} -function help { - printf "\n%s" "usage: sns [-cedlp] " - if [ -z "$VCTL" ]; then - printf "\n%s%s%s" "usage: sns " "$VCTL" " ..." - fi - printf "\n%s" " sns [-hi]" - - printf "\n%s" " -c | --create : Create note" - printf "\n%s" " -C | --config : Edit Config" - printf "\n%s" " -d | --delete : Delete note" - printf "\n%s" " -e | --edit : Open note for editing" - printf "\n%s" " -h | --help : Display this message" - printf "\n%s" " -i | --init : Write default config and initalize SNS store" - printf "\n%s" " -l | --list : List all notes in NOTEBOOK" - printf "\n%s" " -p | --print : Print note to console" - printf "\n\n" -} -function list(){ - # This function, given a folder, $NOTE, will list the contents of $NOTE. - cd "$(dirname "$NOTES_DIR/$NOTE")" - find . -type f -name "*$EXT" | while read file; do - printf "%s\n" "$file" - done - - -} -function p_header(){ - printf "# %s\n## %s\n" "$(basename "${NOTE%.*}")" "$(date "$DATE_FMT")" -} -function print(){ -# Given an existing file, $NOTE, print prints the contents of $NOTE to stdout. - -if [ -r "$NOTE" ]; then - if [ "$ENCRYPTION" == "TRUE" ]; then decrypt #to stdout - else cat "$NOTE"; fi -else - >&2 printf "$RED_COLOR!$RESET_COLOR %s\n\t%s\n"\ - "Note cannot be found." - exit 205 #ERR_NOTE_NO_READ -fi -} -# End Section: Functions -#============================================================================== -# Stage 1: Read Configuration / Verify Integrity -#============================================================================== - -if [ -r "$CONFIG_FILE" ]; then - source "$CONFIG_FILE" - verify_store -elif [ "$1" != "-i" ]; then - >&2 printf "$RED_COLOR!$RESET_COLOR %s\n\t%s\n"\ - "Configuration not found. Please run sns -i." - exit 5 #ERR_NO_STORE -fi - -if [ -d "$NOTES_DIR" ]; then cd "$NOTES_DIR"; fi -if [ "$ENCRYPTION" == "TRUE" ]; then - # If the user chose not to decrypt notes before, clear that preference. - if [ -r "$NOTES_DIR"/.do_not_decrypt ]; then - rm "$NOTES_DIR"/.do_not_decrypt; - fi - # Check if GPG is installed. - if [ ! -r "$(which gpg)" ]; then - >&2 printf "$RED_COLOR!$RESET_COLOR %s\n\t%s\n"\ - "Encryption was specified, but GPG is not installed." - exit 100 - # Check if we have a GPG recipient - elif [ -z "$PUBKEY" ]; then - >&2 printf "$RED_COLOR!$RESET_COLOR %s\n\t%s\n"\ - "No GPG recipient was provided in $CONFIG_FILE. " - exit 110 - # All is good. If any previously unencrypted notes exist, encrypt them. - # No harm in extra security. - else - find . -type f -name "*.$EXT" | grep -v "gpg" | while read TMP_NOTE; do - NOTE="${TMP_NOTE%.$EXT}.gpg.$EXT" - encrypt - if [ -r "$NOTE" ]; then - printf "$YELLOW_COLOR!$RESET_COLOR %s\n" "Encrypted ${NOTE%.$EXT}" - rm "$TMP_NOTE" - fi - done - fi -# If encryption isn't enabled, make sure either all notes are decrypted or the user -# does not wish to decrypt all notes. -else - if [ ! -r "$NOTES_DIR"/.do_not_decrypt ]; then - if [ -n "$(find "$NOTES_DIR" -type f -name "*.gpg.$EXT" > /dev/null)" ]; then - while true; do - read -p "Would you like to de-encrypt previously encrypted notes? " YN - case $YN in - [Yy]* ) - read -s -p "Please enter your passphrase: " PASSPHRASE - cd "$NOTES_DIR" - find . -type f -name "*.gpg.$EXT" | while read -r NOTE; do - gpg\ - --passphrase "$PASSPHRASE"\ - -o "${NOTE%.gpg.note}.note"\ - --decrypt "$NOTE" - - if [ -r "${NOTE%.gpg.note}.note" ]; then - printf "$YELLOW_COLOR!$RESET_COLOR %s\n"\ - "De-encrypted ${NOTE%.gpg.$EXT}" - rm "$NOTE"; - fi - done - break;; - [Nn]* ) - # Remember the user's preference. - touch "$NOTES_DIR/.do_not_decrypt" - break;; - *) - printf " $RED_COLOR!$RESET_COLOR %s\n" "Please enter Y or N" - ;; - esac - done - fi - fi -fi -#============================================================================== -# Stage 2: Argument Parsing -#============================================================================== -NOTE="" -if [ -z "$1" ]; then help; exit 20 -else - INDEX=0 - for ARG in "$@"; do - let INDEX++ - case "$ARG" in - -c|--create) - CREATE="TRUE" - OP="TRUE" - ;; - -C|--config) - if [ -z "$EDITOR" ]; then - printf "$YELLOW_COLOR!$RESET_COLOR - %s\n"\ - "No editor defined. Defaulting to vi." - EDITOR=vi - fi - "$EDITOR" "$CONFIG_FILE" - exit 0; - ;; - -d|--delete) - DELETE="TRUE" - OP="TRUE" - ;; - -e|--edit) - EDIT="TRUE" - OP="TRUE" - ;; - -ce|-ec) - CREATE="TRUE" - EDIT="TRUE" - OP="TRUE" - ;; - -l|--list) - LIST="TRUE" - OP="TRUE" - ;; - -p|--print) - PRINT="TRUE" - OP="TRUE" - ;; - -h|--help) - help - exit 0 - ;; - -i|--init-store) - init_store - exit 0 - ;; - "$VCTL") - cd "$ROOT_DIR" - verctl "${@:$INDEX}" - exit 0 - ;; - *) - NOTE="$ARG" - break; - ;; - esac - done -fi -#============================================================================== -# Section: Actions / Stage 3 -#============================================================================== -# Default behavior -# If no operation was specified, print help and exit on ERR_NO_OP - if [ "$OP" != "TRUE" ]; then - 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 -fi - -if [ "$ENCRYPTION" == "TRUE" ]; then - SESSION_ID="$RANDOM" #SESSION_ID later becomes the temporary filename - readonly NOTE="$NOTE.gpg.$EXT" -else - readonly NOTE="$NOTE.$EXT" -fi - -if [ "$LIST" == "TRUE" ]; then list ; exit 0; 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 -#============================================================================== diff --git a/errors.md b/errors.md index 9e13a94..936ec07 100644 --- a/errors.md +++ b/errors.md @@ -5,18 +5,24 @@ | Name | Code | Meaning | |--------------|------|---------------------------------------| | ERR_NO_STORE | 5 | the SNS store needs to be initialized | -| ERR_NO_ARGS | 10 | No arguments were specified | -| ERR_NO_OP | 20 | No operation was specified | -| ERR_NO_NOTE | 30 | A required argument was not provided | +| | | | +| ERR_NO_OPTS | 10 | No mode argument was specified | +| | | | +| ERR_NO_ARGS | 11 | A mode requiring an argument was | +| | | specified without an argument | +| | | | ### Encryption-related codes -|Name | Code | Meaning | -|------------|------|-------------------------------------------------------| -| ERR_NO_GPG | 100 | Encryption is enabled, but GPG is not installed | -| ERR_NO_KEY | 110 | Encryption is enabled, but no recipient was specified | +|Name | Code | Meaning | +|------------|------|-----------------------------------------| +| ERR_NO_GPG | 100 | Encryption is enabled, but GPG is not | +| | | installed | +| | | | +| ERR_NO_KEY | 110 | Encryption is enabled, but no recipient | +| | | was specified | ### Creation-related codes -|Name | Code | Meaning | -|-----------------|------|-----------------------------------| -| ERR_NOTE_EXiSTS | 200 | The specified note already exists | -| ERR_NOTE_NO_READ| 205 | The specified note cannot be read | +|Name | Code | Meaning | +|-----------------|------|------------------------------------| +| ERR_NOTE_EXiSTS | 200 | The specified note already exists | +| ERR_NOTE_NO_READ| 205 | The specified note cannot be read | diff --git a/install.sh b/install.sh deleted file mode 100755 index d5f0eb8..0000000 --- a/install.sh +++ /dev/null @@ -1,229 +0,0 @@ -#!/bin/bash -# Simple Note System - Install Script -# Copyright (C) 2016, Jon Lewis -# -# This program is free software; you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation; either version 2 of the License, or -# (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License along -# with this program; if not, write to the Free Software Foundation, Inc., -# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. - -# Color codes for messages -readonly RED_COLOR='\033[1;31m' -readonly YELLOW_COLOR='\033[1;33m' -readonly BLUE_COLOR='\033[1;34m' -readonly RESET_COLOR='\033[0m' - - -# Set variables for header -PROD_STR="Simple Note System" -PROD_SUB="Install Script" -# Set default build directory if none specified -if [ ! -d "$BUILD_ROOT" ]; then BUILD_ROOT="build"; fi - -# Set default install prefix according to platform -if [ -z "$INSTALL_DIR" ]; then - case "$(uname)" in - "Darwin" ) - INSTALL_ROOT=/usr/local/opt - ;; - *) - INSTALL_ROOT=/opt - ;; - esac - INSTALL_DIR="$INSTALL_ROOT/sns" -fi - -function sns_out { - # Compile SNS from source files and print the resulting script to stdout - cat ./src/header.src.sh - printf "%s\n" "# Section: Functions" - awk 'NR>=17' ./src/libEncryption.src.sh - awk 'NR>=17' ./src/libStore.src.sh - awk 'NR>=17' ./src/libSNS.src.sh - printf "%s\n" "# End Section: Functions" - awk 'NR>=17' ./src/sns.src.sh -} -function clean { - if [ -d "$BUILD_ROOT" ]; then rm -rf "$BUILD_ROOT"; fi -} -function build_sns { - clean - if [ ! -d ."$BUILD_ROOT" ]; then mkdir $BUILD_ROOT; fi - sns_out > "$BUILD_ROOT/sns" - chmod +x "$BUILD_ROOT/sns" - cp -f ./src/bash-completion.src.sh ./build/bash-completion -} - -function check_install_dir_perms { - STATS=( $(stat -c "%a %u %g" "$INSTALL_ROOT")) - O=$(echo "${STATS[1]}" | cut -c 1) - G=$(echo "${STATS[1]}" | cut -c 2) - E=$(echo "${STATS[1]}" | cut -c 3) - - USER=$(id -u) - GROUP=$(id -g) - - if [ "${STATS[2]}" == "$USER" ] && [ "$O" == "7" ]; then WRITE="1"; - elif [ "${STATS[3]}" == "$GROUP" ] && [ "$G" == "7" ]; then WRITE="1"; - elif [ "$E" == "7" ]; then WRITE="1"; - else WRITE="0"; - fi - - if [ "$(id -u)" == "0" ]; then WRITE=1; fi -} -function install_sns { - # Make sure we can write to "$INSTALL_DIR" - check_install_dir_perms - if [ "$WRITE" == "0" ]; then - printf "$RED_COLOR!$RESET_COLOR - %s %s\n"\ - "Superuser permissions required to install to" "$INSTALL_DIR." - printf "$YELLOW_COLOR!$RESET_COLOR - %s\n"\ - "Will use sudo as necessary." - USE_SUDO="sudo" - else - USE_SUDO="" - fi - # Prepare target environment - "$USE_SUDO" mkdir -p "$INSTALL_DIR" - "$USE_SUDO" mkdir -p "$INSTALL_DIR/bin" - "$USE_SUDO" mkdir -p "$INSTALL_DIR/etc/bash-completion.d" - - # Install files from "$BUILD_ROOT" to "$INSTALL_DIR" - "$USE_SUDO" install -m 0755 "$BUILD_ROOT/sns" "$INSTALL_DIR/bin/sns" - "$USE_SUDO" install -m 0644 "$BUILD_ROOT/bash-completion" "$INSTALL_DIR/etc/bash-completion.d/sns" -} - -function verify { - if [ ! -r "$INSTALL_DIR/bin/sns" ]; then - printf "$RED_COLOR!$RESET_COLOR - %s\n"\ - "could not write to $INSTALL_DIR/bin/sns" - exit 15 - else - printf "$YELLOW_COLOR*$RESET_COLOR - %s $BLUE_COLOR%s$RESET_COLOR\n"\ - "Simple Note System was installed to" "$INSTALL_DIR/bin/sns." - SNS_INSTALLED=1 - fi - - if [ ! -r "$INSTALL_DIR/etc/bash-completion.d/sns" ]; then - printf "$RED_COLOR!$RESET_COLOR - %s\n"\ - "could not write to $INSTALL_DIR/etc/bash-completion.d/sns" - exit 15 - else - printf "$YELLOW_COLOR*$RESET_COLOR - %s $BLUE_COLOR%s$RESET_COLOR\n"\ - "Bash completion was installed to" "$INSTALL_DIR/etc/bash-completion.d/sns." - fi - - DEFAULT_SNS="$(which sns 2>/dev/null)" - if [ -n "$DEFAULT_SNS" ] && [ "$DEFAULT_SNS" != "$INSTALL_DIR/bin/sns" ]; then - printf "$RED_COLOR!$RESET_COLOR - %s %s %s\n"\ - "Another installation of sns"\ - "($DEFAULT_SNS)"\ - "was detected." - fi - if [ -z "$DEFAULT_SNS" ]; then - printf "\n$YELLOW_COLOR*$RESET_COLOR - %s\n\t$YELLOW_COLOR%s\n$RESET_COLOR %s\n\n"\ - "sns was not found in PATH. Please add"\ - "export PATH=$INSTALL_DIR/bin:\$PATH"\ - " to your ~/.bashrc or ~/.bash_profile" - fi - if grep "source $INSTALL_DIR/etc/bash-completion.d/sns" < "$BASH_SETTINGS" > /dev/null; then - SNS_BASH_COMPLETION=1; - else - SNS_BASH_COMPLETION=0; - fi - - if [ "$SNS_BASH_COMPLETION" != "1" ]; then - printf "\n$YELLOW_COLOR*$RESET_COLOR - %s\n\t$YELLOW_COLOR%s\n$RESET_COLOR %s\n\n"\ - "To enable bash completion, add"\ - "source $INSTALL_DIR/etc/bash-completion.d/sns"\ - " to your ~/.bashrc or ~/.bash_profile" - else - printf "$YELLOW_COLOR*$RESET_COLOR - %s\n"\ - "Bash completion already enabled." - fi - - if [ "$SNS_INSTALLED" == "1" ]; then - printf "$YELLOW_COLOR*$RESET_COLOR - %s\n\n%s $BLUE_COLOR%s$RESET_COLOR %s\n"\ - "Installation succeeded." "If this is a new install of sns, you should run"\ - "sns -i" "now." - fi -} - -function print_help { - printf " %s" "usage: ./install [bchiu]" - printf "\n%s" " -b | --build-only : build, but do not install sns" - printf "\n%s" " -c | --clean : clean build directory" - printf "\n%s" " -h | --help : Print this information" - printf "\n%s" " -i | --install : build and install sns" - printf "\n%s" " -u | --uninstall : remove sns from the system (will not remove notes)" - printf "\n\n%s" "Run Variables:" - printf "\n %s %s" "BUILD_DIR= " "Directory to build SNS in" - printf "\n %s %s" "INSTALL_DIR=" "Directory to install SNS to" - printf "\n\n" -} - -# Sanity check -if [ -z "$INSTALL_DIR" ]; then - printf "$RED_COLOR!$RESET_COLOR - %s\n"\ - "Failed to guess optimal install directory please specify with INSTALL_DIR=\n" - exit 10 -fi -if [ -r "$HOME"/.bashrc ]; then - BASH_SETTINGS="$HOME/.bashrc" -elif [ -r "$HOME"/.bash_profile ]; then - BASH_SETTINGS="$HOME/.bash_profile" -else - printf "$RED_COLOR!$RESET_COLOR - %s\n"\ - "Failed to determine bash settings file (e.g. ~/.bashrc)" - exit 13 -fi - -# Print header -printf "\n %s\n" "$PROD_STR" -printf "%s\n\n" "--------------------" -# Argument Parsing -for ARG in "$@"; do - case "$ARG" in - -b|--build-only) - build_sns - printf "\n" - exit - ;; - -c|--clean) - clean - exit - ;; - -u|--uninstall) - check_install_dir_perms - if [ "$WRITE" == "1" ]; then - rm -rf "$INSTALL_DIR" - else - sudo rm -rf "$INSTALL_DIR" - fi - exit - ;; - -i|--install) - build_sns - install_sns - verify - printf "\n" - exit - ;; - -h|--help) - print_help - exit - ;; - esac -done - -print_help -exit diff --git a/sns.sh b/sns.sh new file mode 100755 index 0000000..911c62d --- /dev/null +++ b/sns.sh @@ -0,0 +1,220 @@ +#!/bin/bash +XL_PRODUCT="Simple Note System" +XL_VER="v2a" + +# Environment Constants +readonly SNS_STORE="$HOME/.local/sns" +readonly SNS_KEYFILE="$SNS_STORE/.pubkey" +readonly SNS_DEPS=("gpg2" "tree" "git") +readonly IFS=$'\n\t' +set -euo pipefail + +readonly SNS_RED_COLOR='\033[1;31m' +readonly SNS_YELLOW_COLOR='\033[1;33m' +readonly SNS_RESET_COLOR='\033[0m' + +# Erroneous Exit Constants + + # Invocation Errors + readonly SNS_ERR_NO_STORE=5 # The sns store needs to be initialized + readonly SNS_ERR_NO_OPTS=10 # No mode argument was specified + readonly SNS_ERR_NS_ARGS=11 # The specified mode requires an argument + + # Dependency Errors + readonly SNS_ERR_DEPS=20 # Base error - add the following codes + readonly SNS_ERR_NO_gpg2=1 # GPG is not installed + readonly SNS_ERR_NO_tree=2 # Tree is not installed + readonly SNS_ERR_NO_git=3 # Git is not installed + +# Global Variables +typeset -i SNS_SID="$RANDOM" +typeset -a SNS_ACTION=("") +typeset -a MISSING_DEPS +typeset -i SNS_EXIT=0 +declare SNS_PUBKEY= + +# Function Definitions +# sns_printError Prints an error message +# sns_NoteHeader Prints standard note header to stdout +# sns_checkDeps Checks the system for required dependencies +# sns_checkStore Checks if $SNS_STORE exists +# sns_sanityCheck Wrapper for sns_checkDeps and sns_checkStore +# ---- +# sns_initStore Initializes the SNS Store ( -i) +# sns_printHelp Prints help page ( -h) +# sns_list Lists all notes in `tree` format ( *) +# sns_create Creates note; calls sns_edit() ( -c) +# sns_edit Decrypts note to /tmp, calls editor, re-encrypts note ( -e) +# sns_print Prints note to stdout ( -p) +# sns_rm Deletes note from store ( -d) +# sns_gitPassthrough Passes through all instructions to git (git) + +function sns_printError(){ + printf "$SNS_RED_COLOR!$SNS_RESET_COLOR - %s\n" "$@" +} +function sns_NoteHeader(){ + printf "%s\n%s\n" "Title:" "Date:" +} +function sns_checkDeps(){ + local SNS_RETURN="true"; + for DEP in "${SNS_DEPS[@]}"; do + if test ! -e "$(which "$DEP" 2>/dev/null)"; then + MISSING_DEPS+=("$DEP") + SNS_RETURN="false"; + fi + done + "$SNS_RETURN"; +} +function sns_checkStore(){ + if [ -d "$SNS_STORE" ]; then true; else false; fi +} +function sns_sanityCheck { + if ! sns_checkDeps; then + SNS_EXIT="$SNS_ERR_DEPS" + for DEP in "${MISSING_DEPS[@]}"; do + local SNS_DEP_EC="\$ERR_NO_$DEP" + printError "Dependency %s not in path." "$DEP"; + SNS_EXIT+=${!SNS_DEP_EC} + done + fi + + if [ -r "$SNS_STORE/.pubkey" ]; then + SNS_PUBKEY="$(cat "$SNS_STORE/.pubkey")" + elif ! sns_checkStore; then + if [ "$(echo "${SNS_ACTION[@]}" | awk '{print $1;}')" != "sns_initStore" ]; then + printError "The sns store does not exist." + printf " - %s\n" "Please run \`sns -i [gpg-key]\` to initialize sns." + SNS_EXIT="$SNS_ERR_NO_STORE" + fi + fi +} +#---- +function sns_initStore { + mkdir -p "$SNS_STORE" + echo "$@" | awk '{print $1}' > "$SNS_KEYFILE" +} +function sns_printHelp(){ + printf "%s" "usage: sns [-cedlp] " + printf "\n%s%s%s" "usage: sns " "git" " ..." + printf "\n%s" " sns [-hi]" + + printf "\n%s" " -c | --create : Create note" + printf "\n%s" " -C | --config : Edit Config" + printf "\n%s" " -d | --delete : Delete note" + printf "\n%s" " -e | --edit : Open note for editing" + printf "\n%s" " -h | --help : Display this message" + printf "\n%s" " -i | --init : Write default config and initalize SNS store" + printf "\n%s" " -l | --list : List all notes in NOTEBOOK" + printf "\n%s" " -p | --print : Print note to console" + printf "\n\n" +} +function sns_list(){ + # Change directories to fix tree header + cd "$SNS_STORE" || exit; cd .. || exit; + # Print the tree + tree -C --noreport --prune "$(echo "$@" | awk '{print $1}')" +} +function sns_create(){ + # Make sure the note doesn't already exist + if [ -r "$SNS_STORE/$(echo "$@" | awk '{print $1}')" ]; then + sns_printError "Note already exists." + return + fi + + # Print the standard header to a temporary note + sns_NoteHeader > /tmp/"$SNS_SID" + + # Edit the new note + sns_edit "$(echo "$@" | awk '{print $1}')" +} +function sns_edit(){ + # Make the function more readable + local readonly SNS_NOTE="$SNS_STORE/$(echo "$@" | awk '{print $1}')" + + # Test if edit was called from create + if [ ! -r /tmp/"$SNS_SID" ]; then gpg2 -d -o /tmp/"$SNS_SID" "$SNS_NOTE"; fi + + # Edit the note + vim /tmp/"$SNS_SID" + + # Make sure the notebook/section exists + if [ ! -d "$(dirname "$SNS_NOTE")" ]; then mkdir -p "$(dirname "$SNS_NOTE")"; fi + + # If the note previously existed, make a backup. + if [ -r "$SNS_NOTE" ]; then mv "$SNS_NOTE" "$SNS_NOTE.bk"; fi + + # Re-encrypt it to the store + gpg2 -r "$SNS_PUBKEY" -o "$SNS_NOTE" -e /tmp/"$SNS_SID" + + # If all went well, remove the backup + if [ -r "$SNS_NOTE" ]; then rm "$SNS_NOTE.bk"; fi +} +function sns_print(){ + gpg2 -d "$SNS_STORE/$(echo "$@" | awk '{print $1}')" +} +function sns_rm(){ + rm -f "$SNS_STORE/$(echo "$@" | awk '{print $1}')" +} +function sns_gitPassthrough(){ + cd "$SNS_STORE" || exit; + git "$@"; +} +# ---- +function sns_argParse(){ + ARGS=($@) + #echo "${#ARGS}" + SNS_ACTION=() + while getopts ":i:hc:e:p:d:" OPT; do + + # If an option requiring an argument was passed without an argument, + # inform the user and set exit code to "$SNS_ERR_NS_ARGS" + case "${ARGS[!OPTIND]}" in + -i|-c|-e|-p|-d) + if [ "${#ARGS}" -lt 2 ]; then + printError "A required argument was not given." + SNS_EXIT="$SNS_ERR_NS_ARGS" + return + fi + esac + case "$OPT" in + i) + SNS_ACTION=("sns_initStore" "$OPTARG");; + h) + SNS_ACTION=("sns_printHelp");; + c) + SNS_ACTION=("sns_create $OPTARG");; + e) + SNS_ACTION=("sns_edit $OPTARG");; + p) + SNS_ACTION=("sns_print $OPTARG");; + d) + SNS_ACTION=("sns_rm $OPTARG");; + esac + done + + if [ "${#SNS_ACTION[@]}" -eq 0 ]; then + if [ "$(echo "$@" | awk '{print $1}')" == "git" ]; then + SNS_ACTION=($@) + else + if [ -d "$SNS_STORE/$*" ]; then + SNS_ACTION=("sns_list" "sns/$@") + else + SNS_ACTION=("sns_list" "sns") + fi + fi + fi +} + +# Entry Point +printf "%s\n%s\n" "$XL_PRODUCT" "$XL_VER" +printf "\n" + +sns_argParse "$@" +sns_sanityCheck +if [ "$SNS_EXIT" -eq 0 ]; then + eval "${SNS_ACTION[@]}" +fi + +printf "\n" + +exit "$SNS_EXIT" diff --git a/src/header.src.sh b/src/header.src.sh deleted file mode 100644 index 5fec337..0000000 --- a/src/header.src.sh +++ /dev/null @@ -1,37 +0,0 @@ -#!/bin/bash -# Simple Note System -# Copyright (C) 2016, Jon Lewis -# -# This program is free software; you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation; either version 2 of the License, or -# (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License along -# with this program; if not, write to the Free Software Foundation, Inc., -# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. - -# Prevent freak accidents involving the root directory -if [ -z "$HOME" ]; then HOME=/home/"$(whoami)"; fi - -# Store files and locations -readonly PROD_STR="Simple Note System" -readonly VER_STR="v2.0a12" -readonly ROOT_DIR="$HOME"/.local/sns -readonly NOTES_DIR="$ROOT_DIR"/notes -readonly TMP_DIR="$ROOT_DIR"/tmp -readonly CONFIG_FILE="$ROOT_DIR/sns.conf" - -#Color codes for messages -readonly RED_COLOR='\033[1;31m' -readonly YELLOW_COLOR='\033[1;33m' -readonly RESET_COLOR='\033[0m' - -#Print the program header to stdout -printf "%s\n" "$PROD_STR" -printf "%s\n" "------------------"