diff --git a/build/bash-completion b/build/bash-completion deleted file mode 100644 index 6dcd400..0000000 --- a/build/bash-completion +++ /dev/null @@ -1,97 +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. - -_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-secret-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 --delete --edit --help --print --list --init\ - -c -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 100644 index af843a4..0000000 --- a/build/sns +++ /dev/null @@ -1,416 +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" "- Environment 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 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 - rm "$NOTES_DIR/$NOTE" - printf "%s\n" "- Deleted note: ${NOTE%.*}." - #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 - -} -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" " -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" - ;; - -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" - "${@:$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/install.sh b/install.sh index c56669f..08cb6e7 100755 --- a/install.sh +++ b/install.sh @@ -59,6 +59,7 @@ 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 } diff --git a/src/bash-completion.src.sh b/src/bash-completion.src.sh index 6dcd400..bee1f8c 100644 --- a/src/bash-completion.src.sh +++ b/src/bash-completion.src.sh @@ -74,7 +74,7 @@ _sns() { COMPREPLY=() local cur="${COMP_WORDS[COMP_CWORD]}" - local commands="--create --delete --edit --help --print --list --init\ + local commands="--create --config --delete --edit --help --print --list --init\ -c -d -e -h -p -l -i" if [[ $COMP_CWORD -gt 1 ]]; then local lastarg="${COMP_WORDS[$COMP_CWORD-1]}" diff --git a/src/sns.src.sh b/src/sns.src.sh index 469adaa..ca25794 100644 --- a/src/sns.src.sh +++ b/src/sns.src.sh @@ -105,6 +105,15 @@ else CREATE="TRUE" OP="TRUE" ;; + --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"