Update to version 1.0

5 files changed, 287 insertions, 207 deletions

@@ -0,0 +1,24 @@
+
+Copyright (C) 2022 Case Duckworth <acdw@acdw.net> 
+
+Permission is hereby granted, free of charge, to any person 
+obtaining a copy of this software and associated documentation files 
+(the "Software"), to deal in the Software without restriction, 
+including without limitation the rights to use, copy, modify, merge, 
+publish, distribute, sublicense, and/or sell copies of the Software, 
+and to permit persons to whom the Software is furnished to do so, 
+subject to the following conditions: 
+
+The above copyright notice and this permission notice shall be 
+included in all copies or substantial portions of the Software. 
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 
+BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 
+ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 
+SOFTWARE. 
+
+
@@ -1,19 +0,0 @@
-Copyright 2020 Case Duckworth
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
@@ -1,15 +1,20 @@
 # licenser
 
-PREFIX ?= /usr
+PREFIX = /usr/local
 
-.PHONY: def install uninstall
+.PHONY: help install uninstall
 
-def:
-        @echo "run 'make install' to install"
-        @echo "run 'make uninstall' to uninstall"
+help:
+        @echo "licensor : drop urself a license"
+        @echo "(C) 2021--2022 Case Duckworth <acdw@acdw.net>"
+        @echo
+        @echo "TARGETS:"
+        @echo " install Install licensor to $(DESTDIR)$(PREFIX)/bin/licensor."
+        @echo " uninstall       Uninstall licensor-related files."
 
-install: licenser
+install: licensor
         install -D $< $(DESTDIR)$(PREFIX)/bin
 
 uninstall:
-        rm -f $(DESTDIR)$(PREFIX)/bin/licenser
+        rm -f $(DESTDIR)$(PREFIX)/bin/licensor
+        rm -rf "${XDG_CACHE_HOME:-$HOME/.cache}/licensor"
@@ -1,181 +0,0 @@
-#!/bin/sh
-# licenser: drop a little ol license in there
-# Author: Case Duckworth <acdw@acdw.net>
-# License: MIT
-# Version: 0.2
-
-# Constants
-## where to download licenses from
-PRGN="${0##*/}"
-: "${LICENSER_SOURCE:=https://git.sr.ht/~acdw/licenser-licenses/blob/master}"
-LICENSER_CACHE="${XDG_DATA_HOME:-$HOME/.local/share}/licenser"
-LICENSER_LICENSE="${LICENSER_LICENSE:-MIT}"
-EXEC="${EXEC:-true}"
-
-usage() {
-        cat <<EOF
-$PRGN: plop a license in your project
-
-usage:  $PRGN [-h|-m|-M]
-        $PRGN [-f] [-q] [-y YEAR] [-a AUTHOR] [-e EMAIL] 
-              [-l LANG] [-o FILE] [LICENSE]
-flags:
-        -h      show this help and exit
-        -m      list available licenses and exit
-        -M      list licenses, disregarding cached manifest
-        -f      overwrite existing license
-        -q      quiet: don't log anything
-options:
-        -y YEAR         set copyright date(s) to YEAR.
-                        default: \$(date +%Y).
-                        this option accepts arbitrary input.
-        -a AUTHOR       set copyright holder(s) to AUTHOR.
-                        default:
-                                - git config --get user.name
-                                - getent password \$USER
-                                - \$USER
-        -e EMAIL        set AUTHOR's email address to EMAIL.
-                        default:
-                                - git config --get user.email
-                                - [blank]
-        -l LANG         set license language to LANG.
-                        default: 'en' (subject to change)
-        -o FILE         set output file to FILE.
-                        default: LICENSE in \$PWD
-parameters:
-        LICENSE         which license to use.
-                        default: \$LICENSER_LICENSE, which
-                        defaults to MIT.
-EOF
-}
-
-# entry point
-licenser() {
-        _force=false  # don't replace licenses
-        _quiet=false  # log stuff
-        __OUT=LICENSE # default output file
-        __LANG=en     # default to en because it's got the most licenses XXX
-
-        while getopts hmMfqy:a:e:o:l:s: OPT; do
-                case "$OPT" in
-                h)
-                        usage
-                        exit 0
-                        ;;
-                f) _force=true ;;
-                m)
-                        list_licenses
-                        exit "$?"
-                        ;;
-                M)
-                        list_licenses -f
-                        exit "$?"
-                        ;;
-                q) _quiet=true ;;
-                y) __YEAR="$OPTARG" ;;
-                a) __AUTHOR="$OPTARG" ;;
-                e) __EMAIL="$OPTARG" ;;
-                o) __OUT="$OPTARG" ;;
-                l) __LANG="$OPTARG" ;;
-                *)
-                        usage
-                        exit 1
-                        ;;
-                esac
-        done
-        shift $((OPTIND - 1))
-        __LICENSE="${1:-$LICENSER_LICENSE}"
-
-        if ! __CACHED=$(get_license "$__LICENSE"); then
-                list_licenses
-                exit 2
-        fi
-
-        if [ -e "$__OUT" ] && ! $_force; then
-                log "File exists: $__OUT"
-                exit 3
-        fi
-
-        eval "$(
-                put "cat<<_END_LICENSE_"
-                cat "$__CACHED"
-                put
-                put "_END_LICENSE_"
-        )" >"$__OUT"
-
-        log "$__LICENSE written to $__OUT."
-}
-
-# download a license, or get it from the cache
-# if there's not one, return error
-get_license() {
-        license="$1"
-        cached="$LICENSER_CACHE/$license/$__LANG"
-        source="$LICENSER_SOURCE/$license/$__LANG"
-
-        mkdir -p "$LICENSER_CACHE/$license"
-        log "Checking cache for $license..."
-        if [ ! -f "$cached" ]; then
-                log "Not found. Downloading from $source..."
-                if ! curl -fLo "$cached" "$source"; then
-                        log "License $license unavailable in language: $__LANG"
-                        return 1
-                fi
-        fi
-        put "$cached"
-}
-
-# download a list of the licenses, or get it from the cache
-list_licenses() {
-        cached="$LICENSER_CACHE/manifest"
-        source="$LICENSER_SOURCE/manifest"
-
-        [ "x$1" = "x-r" ] && rm "$cached"
-
-        mkdir -p "$LICENSER_CACHE"
-        log "Checking cache for manifest..."
-        if [ ! -f "$cached" ]; then
-                log "Not found. Downloading from $source..."
-                if ! curl -fLo "$cached" "$LICENSER_SOURCE/manifest"; then
-                        log "Unable to get the manifest"
-                        return 1
-                fi
-        fi
-        cat "$cached"
-}
-
-# template function for the copyright year
-year() {
-        case "$__YEAR" in
-        '') # figure out the year
-                date +%Y ;;
-        *) # one was provided
-                put "$__YEAR" ;;
-        esac
-}
-
-# template function for author/owner
-author() {
-        if [ -z "$__AUTHOR" ]; then
-                __AUTHOR="$(git config --get user.name)" # try from git
-                [ -z "$__AUTHOR" ] && __AUTHOR="$(
-                        getent passwd "$USER" | awk -F: '{sub(/,+/,"",$5);print $5}'
-                )"                                     # or, try from getent
-                [ -z "$__AUTHOR" ] && __AUTHOR="$USER" # give up, get $USER
-        fi
-        put "$__AUTHOR"
-}
-
-email() {
-        if [ -z "$__EMAIL" ]; then
-                __EMAIL="$(git config --get user.email)" # try from git
-        fi
-        [ -n "$__EMAIL" ] && put "<$__EMAIL>"
-}
-
-# helpers
-put() { printf '%s\n' "$*"; }
-log() { $_quiet || put "$PRGN: $*" >&2; }
-
-# run
-$EXEC && licenser "$@"
@@ -0,0 +1,251 @@
+#!/bin/sh
+
+# Constants
+PRGN="${0##*/}"
+LICENSOR_CACHE="${XDG_CACHE_HOME:-$HOME/.cache/licensor"
+# Configuration
+: "${LICENSE_REPO_VERSION:=3.17}"
+: "${LICENSE_REPO_URL:=https://github.com/spdx/license-list-data/archive/refs/tags/v$LICENSE_REPO_VERSION.tar.gz}"
+: "${LICENSE_REPO_PATH:=license-list-data-$LICENSE_REPO_VERSION/template}"
+: "${LICENSOR_LICENSE:=MIT}"
+: "${LICENSOR_OUTPUT_FILE:=COPYING}"
+
+usage() {
+        cat <<EOF
+$PRGN: drop a lil ol license in yr project
+USAGE:  $PRGN [-h|-m|-M]
+        $PRGN [FLAGS] [OPTIONS] [LICENSE]
+
+FLAGS:
+ -h     Display this help and exit.
+ -l     List available licenses and exit.
+ -L     List available licenses, disregarding cache.
+        This flag will re-download the license repo.
+ -f     Overwrite existing license.
+ -q     Be quiet (don't log anything).
+
+OPTIONS:
+ -y YEARS       Set copyright date(s) to YEARS.
+                Default: \$(date +%Y).
+ -a AUTHORS     Set copyright holder(s) to AUTHOR.
+                Default: use the first of
+                        - git config --get user.name
+                        - getent password \$USER
+                        - \$USER
+ -e EMAILS      Set AUTHOR's EMAIL address.
+                Default: \$(git config --get user.email),
+                or stay blank.
+ -o FILE        Output the fetched license to FILE.
+                Default: \$PWD/$LICENSOR_OUTPUT_FILE.
+
+PARAMETERS:
+ LICENSE        The license to use.
+                Default: $LICENSOR_LICENSE.
+EOF
+        exit ${1:-0}
+}
+
+main() {
+        _force=false
+        _quiet=false
+        _fold=1
+        _optional=0
+        __width=70
+        __output="$LICENSOR_OUTPUT_FILE"
+        __year="$(date +%Y)"
+        __author="$(guess_author)"
+        __email="$(guess_email)"
+        __copyright="Copyright (C) $__year $__author <$__email>"
+
+        while getopts hlLs:fzZpPqy:a:e:o:w:c: opt; do
+                case "$opt" in
+                # commands
+                h) usage ;;
+                l) list_licenses && exit || exit $? ;;
+                L) list_licenses -f && exit || exit $? ;;
+                s) search_licenses "$OPTARG" ;;
+                # flags
+                f) _force=true ;;
+                z) _fold=1 ;;
+                Z) _fold=0 ;;
+                p) _optional=1 ;;
+                P) _optional=0 ;;
+                q) _quiet=true ;;
+                # options
+                y) __year="$OPTARG" ;;
+                a) __author="$OPTARG" ;;
+                e) __email="$OPTARG" ;;
+                o) __output="$OPTARG" ;;
+                w) __width="$OPTARG" ;;
+                c) __copyright="$OPTARG" ;;
+                *) usage 1 ;;
+                esac
+        done
+        shift $((OPTIND - 1))
+        __license="${1:-$LICENSOR_LICENSE}"
+
+        if [ -e "$__output" ] && ! $_force; then
+                log "File exists: $__output"
+                exit 3
+        fi
+
+        if [ "x$__output" = x- ]; then
+                __output=/dev/stdout
+        fi
+
+        license_file="$(get_license "$__license")" || exit $?
+        license_convert <"$LICENSOR_CACHE/$license_file.template.txt" \
+                "$__copyright" "$_optional" "$_fold" "$__width" >"$__output"
+        [ "$__output" != /dev/stdout ] && log "$__license license written to $__output."
+}
+
+get_licenses() {
+        # Get licenses from cache, or download them
+        if ! [ -d "$LICENSOR_CACHE" ] || [ "x$1" = "x-f" ]; then
+                log "Downlading licenses from $LICENSE_REPO_URL..."
+                mkdir -p "$LICENSOR_CACHE"
+                tmpfile="/tmp/licenses.tar.gz"
+                if ! [ -f "$tmpfile" ]; then
+                        curl -o "$tmpfile" -L "$LICENSE_REPO_URL" >/dev/null 2>&1 ||
+                                return 1
+                fi
+                log "Extracting licenses to $LICENSOR_CACHE..."
+                if tar -C "$LICENSOR_CACHE" \
+                        -xvf "$tmpfile" --strip-components=2 \
+                        "$LICENSE_REPO_PATH" >/dev/null 2>&1; then
+                        rm "$tmpfile"
+                else
+                        return 1
+                fi
+        fi
+}
+
+get_license() {
+        list_licenses | grep -iE '^'"$1"'$' || {
+                log "Can't find license \"$1\"."
+                exit 1
+        }
+}
+
+list_licenses() {
+        get_licenses "$1" || exit 1
+
+        find "$LICENSOR_CACHE" -iname '*.template.txt' |
+                sort |
+                xargs basename -s .template.txt
+}
+
+search_licenses() {
+        list_licenses | grep -iE "$1"
+        exit $?
+}
+
+guess_author() {
+        author="$(git config --get user.name)"
+        [ -z "$author" ] &&
+                author="$(getent passwd "$USER" | awk -F: '{sub(/,+/,"",$5);print $5}')"
+        [ -z "$author" ] &&
+                author="$USER"
+        put "$author"
+}
+guess_email() {
+        email="$(git config --get user.email)"
+        put "$email"
+}
+
+put() { printf '%s\n' "$*"; }
+log() { $_quiet || put "$PRGN: $*" >&2; }
+
+license_convert() {
+        copyright="$1"          # "Copyright (C) 2022 Case Duckworth <acdw@acdw.net>"
+        show_optional="${2:-0}" # 0
+        fold_output="${3:-1}"   # 1
+        fold_width="${4:-70}"   # 70
+        awk '
+BEGIN {
+        foldOutput = '"$fold_output"'
+        foldWidth = '"$fold_width"'
+        showOptional = '"$show_optional"'
+        copyright = "'"$copyright"'"
+}
+{ buf = buf "\n" $0 }
+END {
+        split(buf, b, "")
+        c = 1
+        out = ""
+        optstr = ""
+        opt = 0
+        while (c <= length(b)) {
+                if (b[c] == "<" && b[c + 1] == "<") {
+                        tok = ""
+                        c += 2
+                        closed = 0
+                        while (! closed) {
+                                tok = tok b[c++]
+                                if (b[c] == ">" && b[c + 1] == ">") {
+                                        closed++
+                                        c += 2
+                                }
+                        }
+                        if (tok ~ /^beginOptional/) {
+                                opt = 1
+                        } else if (tok == "endOptional") {
+                                if (showOptional) {
+                                        out = out optstr
+                                }
+                                opt = 0
+                                optstr = ""
+                        } else if (tok ~ /^var/) {
+                                split(tok, ta, ";")
+                                name = ""
+                                original = ""
+                                for (a in ta) {
+                                        if (ta[a] ~ "^name") {
+                                                match(ta[a], /=".*/)
+                                                name = substr(ta[a], RSTART + 2, RLENGTH - 3)
+                                        } else if (ta[a] ~ "^original") {
+                                                match(ta[a], /=".*/)
+                                                original = substr(ta[a], RSTART + 2, RLENGTH - 3)
+                                        } else if (ta[a] ~ "^match") {
+                                                # currently not used
+                                        }
+                                }
+                                if (name == "copyright") {
+                                        out = out copyright
+                                } else {
+                                        out = out original
+                                }
+                        }
+                        continue
+                }
+                if (opt) {
+                        optstr = optstr b[c++]
+                } else {
+                        out = out b[c++]
+                }
+        }
+        # "Fold" the output
+        if (foldOutput) {
+                split(out, oa, "\n")
+                out = ""
+                for (l in oa) {
+                        split(oa[l], la, FS)
+                        lc = 0
+                        for (w in la) {
+                                lc += length(la[w]) + 1
+                                if (lc >= foldWidth) {
+                                        out = out "\n" la[w] " "
+                                        lc = length(la[w]) + 1
+                                } else {
+                                        out = out la[w] " "
+                                }
+                        }
+                        out = out "\n"
+                }
+        }
+        print out
+}
+'
+}
+
+main "$@"