Append2Org — Send your clipboard to an Org file as a subtree (Bash package)

## Append2Org --- Send your clipboard to an Org file as a subtree
## Commentary
### See the README for more information
## Code
### Settings
### Functions
#### Load variables
#### Produce output
#### Utilities
#### Error messages
#### Main
### Run it and exit
## Append2Org ends here

#!/usr/bin/env bash

## Append2Org --- Send your clipboard to an Org file as a subtree

# SPDX-FileCopyrightText: © flandrew <https://flandrew.srht.site/listful>
# SPDX-License-Identifier: GPL-3.0-or-later

#---------------------#
# Author:  flandrew   #
# Created: 2020-12-01 #
# Updated: 2025-12-17 #
#---------------------#
# Version: 0.2.1      #
#---------------------#

## Commentary
#
# Send the contents of clipboard to the end of an Org file, as an Org subtree.
#
# This is somewhat like org-refile — but it works from anywhere in the system,
# even when Emacs isn't open or available.
#
### See the README for more information
#
# A local README.org should be available in the same directory as this file.
#
# You can also read it online:
#   https://flandrew.srht.site/listful/sw-bash-append2org.html
#
#############################################################################

#⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯
## Code
### Settings

require() { hash "$@" || exit 127 ;}
require xclip zenity

#⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯
### Functions
#### Load variables

loadvars() { : ~/.config/append2org.rc
             # USER: this file^ must exist
             if [[ -f "$_" ]]
             then . "$_"
             else echo "$_ is missing; create it" >&2
                  exit 1
             fi ;}

#⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯
#### Produce output

output()   {
    local input="$1"
    # Let's further fix the input.
    #   We want its first line to always start with "** ".
    #   We also want to be able to batch-add entries.
    if   [[ "${input:0:3}" == "** " ]]; then : ""
    elif [[ "${input:0:3}" == "***" ]]; then : "1 s/^/** (new entry)\n/"
    elif [[ "${input:0:2}" == "* "  ]]; then : "/^[*]+ / s/^/*/"
    else                                     : "1 s/^/** /"
    fi
    input="$(sed -E "$_" <<< "$input")"

    # Then we check if there's a "todo" followed or not by [abc].
    # This is simply so we can feed clipboard with things like:
    #   "todoa Wash cat" and have it sent to inbox as "** TODO [#A] Wash cat".
    : "${input:0:8}"
    : "${_,,}"
    if   [[ "$_" == "** todoa" ]]; then : "1 s/...todoa/** TODO [#A]/I"
    elif [[ "$_" == "** todob" ]]; then : "1 s/...todob/** TODO [#B]/I"
    elif [[ "$_" == "** todoc" ]]; then : "1 s/...todoc/** TODO [#C]/I"
    elif [[ "$_" == "** todo " ]]; then : "1 s/...todo /** TODO /I"
    else                                : ""
    fi
    input="$(sed -E "$_" <<< "$input")"

    # We can be even lazier:
    #   "t a Wash cat".
    : "${input:0:7}"
    : "${_,,}"
    if     [[ "$_" == "** t a " ]]; then : "1 s/...t../** TODO [#A]/I"
    elif   [[ "$_" == "** t b " ]]; then : "1 s/...t../** TODO [#B]/I"
    elif   [[ "$_" == "** t c " ]]; then : "1 s/...t../** TODO [#C]/I"
    else                                 : ""
    fi
    sed -E "$_" <<< "$input"
}

#⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯
#### Utilities

zenemacs() { local wi=(--notification --timeout=10 --text "$1")
             # (Using ":" with "*" here is like using ls and then tail -n1.)
             : /usr/share/emacs/*/etc/images/icons/hicolor/128x128/apps/emacs.png
             [[ -f "$_" ]] && wi+=(--window-icon="$_")
             zenity "${wi[@]}" 2>/dev/null & }

# Remove from the whole input: leading and trailing spaces: [ \t\n\v].
# Then make sure a trailing \n is included.
trim()     { : "$(</dev/stdin)"
             : "${_#"${_%%[^[:space:]]*}"}"
             : "${_%"${_##*[^[:space:]]}"}"
             printf '%s\n' "$_" ;}
trimmed()  { xclip -o -selection clipboard | trim ;}

#⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯
#### Error messages

_zerrmsg() { zenemacs "😕 $1\n   (so I did nothing...)" ;}
emptymsg() { _zerrmsg "Clipboard was empty"   ;}
novarmsg() { _zerrmsg "$1: empty variable"    ;}
nofilmsg() { _zerrmsg "$1: file not found"    ;}
nowrtmsg() { _zerrmsg "$1: file not writable" ;}

#⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯
#### Main

main() {
    local orgfile orglttr orgbase trimmed

    # Set all variables
    loadvars                              #Examples:
    : "${1:-x}"                           # $1; if no $1, return "x"
    orgvari="ORG_${_^^}"                  # Add "ORG"; uppercase it: "ORG_X"
    orgfile="${!orgvari}"                 # Value of "$ORG_X": ~/org/inbox.org
    orgname="$(basename "$orgfile" .org)" # Basename: inbox
    trimmed="$(trimmed)"

    # Make sure we'd be able to append
    if   ! [[ -n "$trimmed" ]]; then emptymsg           ; exit 2
    elif ! [[ -n "$orgfile" ]]; then novarmsg "$orgvari"; exit 3
    elif ! [[ -f "$orgfile" ]]; then nofilmsg "$orgfile"; exit 4
    elif ! [[ -w "$orgfile" ]]; then nowrtmsg "$orgfile"; exit 5
    fi

    # No errors? Then append to the org file,
    # and show notification message — something like this:
    # 📥 INBOX\n<Contents we appended>
    output "$trimmed" | tee -a "$orgfile" |
        zenemacs "${ORG_MSG_INCOMING_SYMBOL:-📥} ${orgname^^}\n$(</dev/stdin)"
}

#⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯⎯
### Run it and exit

main "$@"
exit 0

# Local Variables:
# coding:                     utf-8
# indent-tabs-mode:           nil
# sentence-end-double-space:  nil
# outline-regexp:             "###* "
# End:

## Append2Org ends here