From 6ccdfaafa836f871ae2be1c5fda5d744a6359028 Mon Sep 17 00:00:00 2001 From: Landon Curt Noll Date: Sun, 31 Dec 2023 23:09:43 -0800 Subject: [PATCH] release inc/gen-author.sh Released version "1.0 2023-12-31" of `inc/gen-author.sh`. Added a comment to `inc/pandoc_wrapper.sh` that the 2nd (output.html) may be - to write to standard output (stdout). --- inc/gen-author.sh | 738 +++++++++++++++++++++++++++++++++++++++++- inc/pandoc_wrapper.sh | 1 + 2 files changed, 738 insertions(+), 1 deletion(-) diff --git a/inc/gen-author.sh b/inc/gen-author.sh index a982d0b2f..b7541df41 100755 --- a/inc/gen-author.sh +++ b/inc/gen-author.sh @@ -1,4 +1,740 @@ #!/usr/bin/env bash # -# gen-author.sh - stub for an actual gen-author tool +# gen-author.sh - output winning author(s) related HTML +# +# This tool is intended to be used as a 'before tool' during HTML phase number 20. +# +# This tool is intended to be invoked by a tool such as 'readme2index.sh" +# and as such, the leading options will include "-p pandoc_wrapper" and -P "optstr", +# the final arg will be in yyyy/dir form, and will be called from +# the topdir directory under which the yyyy/dir winner directory must be found. +# +# Copyright (c) 2023 by Landon Curt Noll. All Rights Reserved. +# +# Permission to use, copy, modify, and distribute this software and +# its documentation for any purpose and without fee is hereby granted, +# provided that the above copyright, this permission notice and text +# this comment, and the disclaimer below appear in all of the following: +# +# supporting documentation +# source copies +# source works derived from this source +# binaries derived from this source or from derived source +# +# LANDON CURT NOLL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, +# INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO +# EVENT SHALL LANDON CURT NOLL BE LIABLE FOR ANY SPECIAL, INDIRECT OR +# CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF +# USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR +# OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR +# PERFORMANCE OF THIS SOFTWARE. +# +# chongo (Landon Curt Noll, http://www.isthe.com/chongo/index.html) /\oo/\ +# +# Share and enjoy! :-) + +# firewall - must be bash with a version 4.2 or later +# +# We must declare arrays with -ag or -Ag +# +if [[ -z ${BASH_VERSINFO[0]} || ${BASH_VERSINFO[0]} -lt 4 || ${BASH_VERSINFO[0]} -eq 4 && ${BASH_VERSINFO[1]} -lt 2 ]]; then + echo "$0: ERROR: bash version must be >= 4.2: $BASH_VERSION" 1>&2 + exit 4 +fi + +# setup bash file matching +# +# Requires bash with a version 4.2 or later +# +shopt -s nullglob # enable expanded to nothing rather than remaining unexpanded +shopt -u failglob # disable error message if no matches are found +shopt -u dotglob # disable matching files starting with . +shopt -s globskipdots # enable never matching . nor .. +shopt -u nocaseglob # disable strict case matching +shopt -u extglob # enable extended globbing patterns +shopt -s globstar # enable ** to match all files and zero or more directories and subdirectories + +# set variables referenced in the usage message +# +export VERSION="1.0 2023-12-31" +NAME=$(basename "$0") +export NAME +export V_FLAG=0 +GIT_TOOL=$(type -P git) +export GIT_TOOL +if [[ -z "$GIT_TOOL" ]]; then + echo "$0: FATAL: git tool is not installed or not in PATH" 1>&2 + exit 100 +fi +"$GIT_TOOL" rev-parse --is-inside-work-tree >/dev/null 2>&1 +status="$?" +if [[ $status -eq 0 ]]; then + TOPDIR=$("$GIT_TOOL" rev-parse --show-toplevel) +fi +export PANDOC_WRAPPER="inc/pandoc_wrapper.sh" +export PANDOC_WRAPPER_OPTSTR="-f markdown -t html --fail-if-warnings=true" +export REPO_URL="https://github.com/ioccc-src/temp-test-ioccc" + +# set usage message +# +export USAGE="usage: $0 [-h] [-v level] [-V] [-n] [-N] + [-d topdir] [-p tool] [-P optstr] + [-u repo_url] [-e string ..] [-E exitcode] + yyyy/dir + + -h print help message and exit + -v level set verbosity level (def level: 0) + -V print version string and exit + + -d topdir set topdir (def: $TOPDIR) + + -n go thru the actions, but do not update any files (def: do the action) + -N do not process file, just parse arguments and ignore the file (def: process the file) + + -p tool run 'pandoc wrapper tool' (not pandoc path) during HTML phase number 21 (def: use $PANDOC_WRAPPER) + -P pandoc_opts run 'pandoc wrapper tool' with options found in 'optstr' (def: $PANDOC_WRAPPER_OPTSTR) + NOTE: The 'optstr' may not contain a single-quote, nor a double-quote. + + -u repo_url URL of the final target repo from where HTML files will be viewed (def: $REPO_URL) + + -e string output string, followed by newline, to stderr (def: do not) + -E exitcode force exit with exitcode (def: exit based on success or failure of the action) + + yyyy/dir path from topdir to winner directory: must contain the files: README.md, .path and .winner.json + +Exit codes: + 0 all OK + 1 pandoc exited non-zero + 2 -h and help string printed or -V and version string printed + 3 command line error + 4 bash version is < 4.2 + 5 yyyy/dir is not a winner directory + 6 pandoc tool not found or not executable + >= 10 < 100 ((not used)) + >= 100 internal error + +$NAME version: $VERSION" + +# setup +# +export NOOP= +export DO_NOT_PROCESS= + +# output_author_handles +# +# Write the author handle(s) for the yyyy/dir winner to standard output (stdout) +# +# XXX - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - XXX +# XXX - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - XXX +# XXX - until we have the jnamval command, we must FAKE PARSE the .winner.json file - XXX +# XXX - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - XXX +# XXX - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - XXX +# +# usage: +# output_author_handles yyyy/dir/.winner.json +# +# returns: +# 0 ==> no errors detected, but output may be empty +# > 0 ==> function error number +# +function output_author_handles +{ + local WINNER_JSON_PATH; # the .winner.json path + local author_handle; # a found author handle + + # parse args + # + if [[ $# -ne 1 ]]; then + echo "$0: ERROR: in output_author_handles: expected 1 arg, found $#" 1>&2 + return 1 + fi + WINNER_JSON_PATH="$1" + if [[ ! -e $WINNER_JSON_PATH ]]; then + echo "$0: ERROR: in output_author_handles: .winner.json does not exist: $WINNER_JSON_PATH" 1>&2 + return 2 + fi + if [[ ! -f $WINNER_JSON_PATH ]]; then + echo "$0: ERROR: in output_author_handles: .winner.json is not a file: $WINNER_JSON_PATH" 1>&2 + return 3 + fi + if [[ ! -r $WINNER_JSON_PATH ]]; then + echo "$0: ERROR: in output_author_handles: .winner.json is not a readable file: $WINNER_JSON_PATH" 1>&2 + return 4 + fi + + # extract author handles from .winner.json + # + grep -F author_handle "$WINNER_JSON_PATH" | + awk 'NF == 5 { print $4; }' | + tr -d '"' | + while read -r author_handle; do + echo "$author_handle" + done + return 0 +} + +# output_winner_ids +# +# Write the winner ids from an author/author_handle.json file to standard output (stdout) +# +# XXX - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - XXX +# XXX - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - XXX +# XXX - until we have the jnamval command, we must FAKE PARSE the author/author_handle.json file - XXX +# XXX - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - XXX +# XXX - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - XXX +# +# usage: +# output_winner_ids author/author_handle.json +# +# returns: +# 0 ==> no errors detected, but output may be empty +# > 0 ==> function error number +# +function output_winner_ids +{ + local AUTHOR_HANDLE_JSON_PATH; # the .winner.json path + local winner_id; # a found winner id + + # parse args + # + if [[ $# -ne 1 ]]; then + echo "$0: ERROR: in output_winner_ids: expected 1 arg, found $#" 1>&2 + return 1 + fi + AUTHOR_HANDLE_JSON_PATH="$1" + if [[ ! -e $AUTHOR_HANDLE_JSON_PATH ]]; then + echo "$0: ERROR: in output_winner_ids: author_handle.json does not exist: $AUTHOR_HANDLE_JSON_PATH" 1>&2 + return 2 + fi + if [[ ! -f $AUTHOR_HANDLE_JSON_PATH ]]; then + echo "$0: ERROR: in output_winner_ids: author_handle.json is not a file: $AUTHOR_HANDLE_JSON_PATH" 1>&2 + return 3 + fi + if [[ ! -r $AUTHOR_HANDLE_JSON_PATH ]]; then + echo "$0: ERROR: in output_winner_ids: author_handle.json is not a readable file: $AUTHOR_HANDLE_JSON_PATH" 1>&2 + return 4 + fi + + # extract winner ids from the author/author_handle.json file + # + grep -F winner_id "$AUTHOR_HANDLE_JSON_PATH" | + awk 'NF == 5 { print $4; }' | + tr -d '"' | + while read -r winner_id; do + echo "$winner_id" + done + return 0 +} + +# output_full_name +# +# Write the Full Name from an author/author_handle.json file to standard output (stdout) +# +# XXX - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - XXX +# XXX - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - XXX +# XXX - until we have the jnamval command, we must FAKE PARSE the author/author_handle.json file - XXX +# XXX - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - XXX +# XXX - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - XXX +# +# usage: +# output_full_name author/author_handle.json +# +# returns: +# 0 ==> no errors detected, but output may be empty +# > 0 ==> function error number +# +function output_full_name +{ + local AUTHOR_HANDLE_JSON_PATH; # the .winner.json path + + # parse args + # + if [[ $# -ne 1 ]]; then + echo "$0: ERROR: in output_full_name: expected 1 arg, found $#" 1>&2 + return 1 + fi + AUTHOR_HANDLE_JSON_PATH="$1" + if [[ ! -e $AUTHOR_HANDLE_JSON_PATH ]]; then + echo "$0: ERROR: in output_full_name: author_handle.json does not exist: $AUTHOR_HANDLE_JSON_PATH" 1>&2 + return 2 + fi + if [[ ! -f $AUTHOR_HANDLE_JSON_PATH ]]; then + echo "$0: ERROR: in output_full_name: author_handle.json is not a file: $AUTHOR_HANDLE_JSON_PATH" 1>&2 + return 3 + fi + if [[ ! -r $AUTHOR_HANDLE_JSON_PATH ]]; then + echo "$0: ERROR: in output_full_name: author_handle.json is not a readable file: $AUTHOR_HANDLE_JSON_PATH" 1>&2 + return 4 + fi + + # extract Full Name from the author/author_handle.json file + # + grep -F full_name "$AUTHOR_HANDLE_JSON_PATH" | sed -e 's/.*"full_name" : "//' -e 's/",.*//' + return 0 +} + +# output_location_code +# +# Write the Location Code from an author/author_handle.json file to standard output (stdout) +# +# XXX - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - XXX +# XXX - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - XXX +# XXX - until we have the jnamval command, we must FAKE PARSE the author/author_handle.json file - XXX +# XXX - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - XXX +# XXX - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - XXX +# +# usage: +# output_location_code author/author_handle.json +# +# returns: +# 0 ==> no errors detected, but output may be empty +# > 0 ==> function error number +# +function output_location_code +{ + local AUTHOR_HANDLE_JSON_PATH; # the .winner.json path + + # parse args + # + if [[ $# -ne 1 ]]; then + echo "$0: ERROR: in output_location_code: expected 1 arg, found $#" 1>&2 + return 1 + fi + AUTHOR_HANDLE_JSON_PATH="$1" + if [[ ! -e $AUTHOR_HANDLE_JSON_PATH ]]; then + echo "$0: ERROR: in output_location_code: author_handle.json does not exist: $AUTHOR_HANDLE_JSON_PATH" 1>&2 + return 2 + fi + if [[ ! -f $AUTHOR_HANDLE_JSON_PATH ]]; then + echo "$0: ERROR: in output_location_code: author_handle.json is not a file: $AUTHOR_HANDLE_JSON_PATH" 1>&2 + return 3 + fi + if [[ ! -r $AUTHOR_HANDLE_JSON_PATH ]]; then + echo "$0: ERROR: in output_location_code: author_handle.json is not a readable file: $AUTHOR_HANDLE_JSON_PATH" 1>&2 + return 4 + fi + + # extract Location Code from the author/author_handle.json file + # + grep -F location_code "$AUTHOR_HANDLE_JSON_PATH" | sed -e 's/.*"location_code" : "//' -e 's/",.*//' + return 0 +} + +# parse command line +# +while getopts :hv:Vd:nNp:P:u:e:E: flag; do + case "$flag" in + h) echo "$USAGE" 1>&2 + exit 2 + ;; + v) V_FLAG="$OPTARG" + ;; + V) echo "$VERSION" + exit 2 + ;; + d) TOPDIR="$OPTARG" + ;; + n) NOOP="-n" + ;; + N) DO_NOT_PROCESS="-N" + ;; + p) PANDOC_WRAPPER="$OPTARG" + ;; + P) # parse -P optstr + case "$OPTARG" in + *"'"*) + echo "$0: ERROR: in -P optstr, the optstr may not contain a single-quote character: $OPTARG" 1>&2 + echo 1>&2 + print_usage 1>&2 + exit 3 + ;; + *'"'*) + echo "$0: ERROR: in -P optstr, the optstr may not contain a double-quote character: $OPTARG" 1>&2 + echo 1>&2 + print_usage 1>&2 + exit 3 + ;; + *) ;; + esac + PANDOC_WRAPPER_OPTSTR="$OPTARG" + ;; + u) REPO_URL="$OPTARG" + ;; + e) echo "$OPTARG" 1>&2 + ;; + E) exit "$OPTARG" + ;; + \?) echo "$0: ERROR: invalid option: -$OPTARG" 1>&2 + echo 1>&2 + print_usage 1>&2 + exit 3 + ;; + :) echo "$0: ERROR: option -$OPTARG requires an argument" 1>&2 + echo 1>&2 + echo "$USAGE" 1>&2 + exit 3 + ;; + *) echo "$0: ERROR: unexpected value from getopts: $flag" 1>&2 + echo 1>&2 + echo "$USAGE" 1>&2 + exit 3 + ;; + esac +done + +# parse the command line arguments +# +if [[ $V_FLAG -ge 1 ]]; then + echo "$0: debug[1]: debug level: $V_FLAG" 1>&2 +fi +# +shift $(( OPTIND - 1 )); +# +if [[ $V_FLAG -ge 5 ]]; then + echo "$0: debug[5]: file argument count: $#" 1>&2 +fi +if [[ $# -ne 1 ]]; then + echo "$0: ERROR: expected 1 arg, found: $#" 1>&2 + exit 3 +fi +# +export WINNER_PATH="$1" +if [[ $V_FLAG -ge 1 ]]; then + echo "$0: debug[1]: WINNER_PATH=$WINNER_PATH" 1>&2 +fi + +# verify that we have a topdir directory +# +REPO_NAME=$(basename "$REPO_URL") +export REPO_NAME +if [[ -z $TOPDIR ]]; then + echo "$0: ERROR: cannot find top of git repo directory" 1>&2 + echo "$0: Notice: if needed: $GIT_TOOL clone $REPO_URL; cd $REPO_NAME" 1>&2 + exit 101 +fi +if [[ ! -d $TOPDIR ]]; then + echo "$0: ERROR: TOPDIR is not a directory: $TOPDIR" 1>&2 + echo "$0: Notice: if needed: $GIT_TOOL clone $REPO_URL; cd $REPO_NAME" 1>&2 + exit 102 +fi + +# verify that we have an author subdirectory +# +export AUTHOR_PATH="$TOPDIR/author" +if [[ ! -d $AUTHOR_PATH ]]; then + echo "$0: ERROR: author is not a directory under topdir: $AUTHOR_PATH" 1>&2 + exit 103 +fi +export AUTHOR_DIR="author" + +# cd to topdir +# +if [[ ! -e $TOPDIR ]]; then + echo "$0: ERROR: cannot cd to non-existent path: $TOPDIR" 1>&2 + exit 104 +fi +if [[ ! -d $TOPDIR ]]; then + echo "$0: ERROR: cannot cd to a non-directory: $TOPDIR" 1>&2 + exit 105 +fi +export CD_FAILED +if [[ $V_FLAG -ge 5 ]]; then + echo "$0: debug[5]: about to: cd $TOPDIR" 1>&2 +fi +cd "$TOPDIR" || CD_FAILED="true" +if [[ -n $CD_FAILED ]]; then + echo "$0: ERROR: cd $TOPDIR failed" 1>&2 + exit 106 +fi +if [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: now in directory: $(/bin/pwd)" 1>&2 +fi + +# verify that WINNER_PATH is a winner directory +# +# WINNER_PATH must be in yyyy/dir form +# yyyy must be a directory +# yyyy must be a writable directory +# yyyy/.year must be a non-empty file +# yyyy/dir must be a directory +# yyyy/dir/.path must be a non-empty file +# WINNER_PATH must match the contents of yyyy/dir/.path +# yyyy/dir/.winner.json must be a non-empty file +# +if [[ ! -d $WINNER_PATH ]]; then + echo "$0: ERROR: arg is not a directory: $WINNER_PATH" 1>&2 + exit 5 +fi +if [[ ! -w $WINNER_PATH ]]; then + echo "$0: ERROR: arg is not a writable directory: $WINNER_PATH" 1>&2 + exit 5 +fi +export YEAR_DIR=${WINNER_PATH%%/*} +if [[ -z $YEAR_DIR ]]; then + echo "$0: ERROR: arg not in yyyy/dir form: $WINNER_PATH" 1>&2 + exit 5 +fi +export WINNER_DIR=${WINNER_PATH#*/} +if [[ -z $WINNER_DIR ]]; then + echo "$0: ERROR: arg: $WINNER_PATH not in $YEAR_DIR/dir form: $WINNER_PATH" 1>&2 + exit 5 +fi +if [[ $WINNER_DIR = */* ]]; then + echo "$0: ERROR: dir from arg: $WINNER_PATH contains a /: $WINNER_DIR" 1>&2 + exit 5 +fi +if [[ ! -d $YEAR_DIR ]]; then + echo "$0: ERROR: yyyy from arg: $WINNER_PATH is not a directory: $YEAR_DIR" 1>&2 + exit 5 +fi +export WINNER_ID="${YEAR_DIR}_${WINNER_DIR}" +export DOT_YEAR="$YEAR_DIR/.year" +if [[ ! -s $DOT_YEAR ]]; then + echo "$0: ERROR: not a non-empty file: $DOT_YEAR" 1>&2 + exit 5 +fi +if [[ ! -d $YEAR_DIR/$WINNER_DIR ]]; then + echo "$0: ERROR: yyyy/dir from arg: $WINNER_PATH is not a directory: $YEAR_DIR/$WINNER_DIR" 1>&2 + exit 5 +fi +export DOT_PATH="$YEAR_DIR/$WINNER_DIR/.path" +if [[ ! -s $DOT_PATH ]]; then + echo "$0: ERROR: not a non-empty file: $DOT_PATH" 1>&2 + exit 5 +fi +DOT_PATH_CONTENT=$(< "$DOT_PATH") +if [[ $WINNER_PATH != "$DOT_PATH_CONTENT" ]]; then + echo "$0: ERROR: arg: $WINNER_PATH does not match $DOT_PATH contents: $DOT_PATH_CONTENT" 1>&2 + exit 5 +fi +export WINNER_JSON="$YEAR_DIR/$WINNER_DIR/.winner.json" +if [[ ! -e $WINNER_JSON ]]; then + echo "$0: ERROR: .winner.json does not exist: $WINNER_JSON" 1>&2 + exit 5 +fi +if [[ ! -f $WINNER_JSON ]]; then + echo "$0: ERROR: .winner.json is not a file: $WINNER_JSON" 1>&2 + exit 5 +fi +if [[ ! -r $WINNER_JSON ]]; then + echo "$0: ERROR: .winner.json is not a readable file: $WINNER_JSON" 1>&2 + exit 5 +fi +if [[ ! -e $PANDOC_WRAPPER ]]; then + echo "$0: ERROR: pandoc wrapper tool does not exist: $PANDOC_WRAPPER" 1>&2 + exit 6 +fi +if [[ ! -f $PANDOC_WRAPPER ]]; then + echo "$0: ERROR: pandoc wrapper tool is not a file: $PANDOC_WRAPPER" 1>&2 + exit 6 +fi +if [[ ! -x $PANDOC_WRAPPER ]]; then + echo "$0: ERROR: pandoc wrapper tool is not an executable file: $PANDOC_WRAPPER" 1>&2 + exit 6 +fi + +# parameter debugging +# +if [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: YEAR_DIR=$YEAR_DIR" 1>&2 + echo "$0: debug[3]: WINNER_DIR=$WINNER_DIR" 1>&2 + echo "$0: debug[3]: WINNER_ID=$WINNER_ID" 1>&2 + echo "$0: debug[3]: DOT_YEAR=$DOT_YEAR" 1>&2 + echo "$0: debug[3]: DOT_PATH=$DOT_PATH" 1>&2 + echo "$0: debug[3]: WINNER_JSON=$WINNER_JSON" 1>&2 + echo "$0: debug[3]: REPO_URL=$REPO_URL" 1>&2 + echo "$0: debug[3]: REPO_NAME=$REPO_NAME" 1>&2 + echo "$0: debug[3]: AUTHOR_PATH=$AUTHOR_PATH" 1>&2 + echo "$0: debug[3]: AUTHOR_DIR=$AUTHOR_DIR" 1>&2 + echo "$0: debug[3]: PANDOC_WRAPPER=$PANDOC_WRAPPER" 1>&2 + echo "$0: debug[3]: PANDOC_WRAPPER_OPTSTR=$PANDOC_WRAPPER_OPTSTR" 1>&2 + echo "$0: debug[3]: DO_NOT_PROCESS=$DO_NOT_PROCESS" 1>&2 + echo "$0: debug[3]: NOOP=$NOOP" 1>&2 +fi + +# If -N, time to exit +# +if [[ -n $DO_NOT_PROCESS ]]; then + if [[ $V_FLAG -ge 1 ]]; then + echo "$0: debug[1]: arguments parsed, -N given, exit 0" 1>&2 + fi + exit 0 +fi + +# Set AUTHOR_HANDLE_SET with author handles from .winner.json +# +export AUTHOR_HANDLE_SET +AUTHOR_HANDLE_SET=$(output_author_handles "$WINNER_JSON") +status="$?" +if [[ $status -ne 0 || -z $AUTHOR_HANDLE_SET ]]; then + echo "$0: ERROR: unable to obtain any author handles from: $WINNER_JSON" 1>&2 + exit 107 +fi +if [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: author handles found in $WINNER_JSON start below" 1>&2 + echo "$AUTHOR_HANDLE_SET" 1>&2 + echo "$0: debug[3]: author handles found in $WINNER_JSON end above" 1>&2 +fi + +# verify each author handle has a readable /author/author_handle.json file +# +for author_handle in $AUTHOR_HANDLE_SET; do + + # determine the author handle JSON path + # + AUTHOR_HANDLE_JSON="$AUTHOR_DIR/$author_handle.json" + + # verify that /author/author_handle.json exists as a readable file + # + if [[ ! -e $AUTHOR_HANDLE_JSON ]]; then + echo "$0: ERROR: for author handle: $author_handle author JSON file not found: $AUTHOR_HANDLE_JSON" 1>&2 + exit 108 + fi + if [[ ! -f $WINNER_JSON ]]; then + echo "$0: ERROR: for author handle: $author_handle author JSON is not a file: $AUTHOR_HANDLE_JSON" 1>&2 + exit 109 + fi + if [[ ! -r $WINNER_JSON ]]; then + echo "$0: ERROR: for author handle: $author_handle author JSON is not a readable file: $AUTHOR_HANDLE_JSON" 1>&2 + exit 110 + fi + if [[ $V_FLAG -ge 5 ]]; then + echo "$0: debug[5]: for author handle: $author_handle found a readable author JSON file: $AUTHOR_HANDLE_JSON" 1>&2 + fi + + # verify that the /author/author_handle.json file lists the WINNER_ID as one of their wins + # + WINNER_ID_FOUND=$(output_winner_ids "$AUTHOR_HANDLE_JSON" | grep -F -- "$WINNER_ID") + status="$?" + if [[ $status -ne 0 || -z $WINNER_ID_FOUND ]]; then + echo "$0: ERROR: winner id: $WINNER_ID not found in author JSON file: $AUTHOR_HANDLE_JSON, status: $status" 1>&2 + exit 111 + fi + if [[ $V_FLAG -ge 7 ]]; then + echo "$0: debug[7]: readable author JSON file: $AUTHOR_HANDLE_JSON mentions winner id: $WINNER_ID" 1>&2 + fi + + # verify that we have a Full Name in the /author/author_handle.json file + # + FULL_NAME=$(output_full_name "$AUTHOR_HANDLE_JSON") + status="$?" + if [[ $status -ne 0 || -z $FULL_NAME ]]; then + echo "$0: ERROR: author JSON file: $AUTHOR_HANDLE_JSON as no FULL NAME, status: $status" 1>&2 + exit 112 + fi + if [[ $V_FLAG -ge 7 ]]; then + echo "$0: debug[7]: author JSON file: $AUTHOR_HANDLE_JSON Full Name: $FULL_NAME" 1>&2 + fi + + # verify that we have a Location Code in the /author/author_handle.json file + # + LOCATION_CODE=$(output_location_code "$AUTHOR_HANDLE_JSON") + status="$?" + if [[ $status -ne 0 || -z $LOCATION_CODE ]]; then + echo "$0: ERROR: author JSON file: $AUTHOR_HANDLE_JSON as no Location Code, status: $status" 1>&2 + exit 113 + fi + if [[ $V_FLAG -ge 7 ]]; then + echo "$0: debug[7]: author JSON file: $AUTHOR_HANDLE_JSON Location Code: $LOCATION_CODE" 1>&2 + fi +done + +# create a temporary markdown for pandoc to process +# +TMP_FILE=".$NAME.$$.md" +if [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: temporary markdown file: $TMP_FILE" 1>&2 +fi +if [[ -z $NOOP ]]; then + trap 'rm -f $TMP_FILE; exit' 0 1 2 3 15 + rm -f "$TMP_FILE" + if [[ -e $TMP_FILE ]]; then + echo "$0: ERROR: cannot remove temporary markdown file: $TMP_FILE" 1>&2 + exit 114 + fi + :> "$TMP_FILE" + if [[ ! -e $TMP_FILE ]]; then + echo "$0: ERROR: cannot create temporary markdown file: $TMP_FILE" 1>&2 + exit 115 + fi +elif [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: because of -n, temporary markdown file is not used: $TMP_FILE" 1>&2 +fi + +# write author header to temporary markdown file +# +if [[ -z $NOOP ]]; then + { + echo '# author' + echo + } >> "$TMP_FILE" +elif [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: -n disabled write: # author" 1>&2 + echo "$0: debug[3]: -n disabled write:" 1>&2 +fi + +# write each author's information to temporary markdown file +# +for author_handle in $AUTHOR_HANDLE_SET; do + + # determine the author handle JSON path + # + AUTHOR_HANDLE_JSON="$AUTHOR_DIR/$author_handle.json" + + # obtain the Full Name from the author handle JSON file + # + FULL_NAME=$(output_full_name "$AUTHOR_HANDLE_JSON") + status="$?" + if [[ $status -ne 0 || -z $FULL_NAME ]]; then + echo "$0: ERROR: author JSON file: $AUTHOR_HANDLE_JSON as no FULL NAME, status: $status" 1>&2 + exit 116 + fi + + # obtain the Location Code from the author handle JSON file + # + LOCATION_CODE=$(output_location_code "$AUTHOR_HANDLE_JSON") + status="$?" + if [[ $status -ne 0 || -z $LOCATION_CODE ]]; then + echo "$0: ERROR: author JSON file: $AUTHOR_HANDLE_JSON as no Location Code, status: $status" 1>&2 + exit 117 + fi + + # write this author's information + # + if [[ -z $NOOP ]]; then + { + echo "[$FULL_NAME](/winners.html#$author_handle)" + echo "Location: [$LOCATION_CODE](/location.html#$LOCATION_CODE)" + echo + } >> "$TMP_FILE" + elif [[ $V_FLAG -ge 3 ]]; then + echo "$0: debug[3]: -n disabled write: [$FULL_NAME](/winners.html#$author_handle)" 1>&2 + echo "$0: debug[3]: -n disabled write: Location: [$LOCATION_CODE](/location.html#$LOCATION_CODE)" 1>&2 + echo "$0: debug[3]: -n disabled write:" 1>&2 + fi +done + +# convert temporary markdown file into HTML +# +if [[ -z $NOOP ]]; then + if [[ $V_FLAG -ge 1 ]]; then + echo "$0: debug[1]: about to execute: $PANDOC_WRAPPER -P $PANDOC_WRAPPER_OPTSTR $TMP_FILE -" 1>&2 + fi + "$PANDOC_WRAPPER" -P "$PANDOC_WRAPPER_OPTSTR" "$TMP_FILE" - + status="$?" + if [[ $status -ne 0 ]]; then + echo "$0: ERROR: pandoc failed, error: $status" 1>&2 + exit 118 + fi +elif [[ $V_FLAG -ge 1 ]]; then + echo "$0: debug[1]: -n disabled execution of: $PANDOC_WRAPPER -P $PANDOC_WRAPPER_OPTSTR $TMP_FILE -" 1>&2 +fi + +# All Done!!! -- Jessica Noll, Age 2 +# +if [[ -z $NOOP ]]; then + rm -f "$TMP_FILE" +elif [[ $V_FLAG -ge 1 ]]; then + echo "$0: debug[1]: -n disabled execution of: rm -f $TMP_FILE" 1>&2 +fi exit 0 diff --git a/inc/pandoc_wrapper.sh b/inc/pandoc_wrapper.sh index 077f6408d..2e694dc69 100755 --- a/inc/pandoc_wrapper.sh +++ b/inc/pandoc_wrapper.sh @@ -104,6 +104,7 @@ export USAGE="usage: $0 [-h] [-v level] [-V] [-n] [-N] file.md markdown file to convert into HTML output.html HTML generated by pandoc from file.md + NOTE: Use - to write to standard output (stdout) NOTE: Without -n, will prepend '-o output.html' as first pandoc options With -n, will append '-o /dev/null' as last pandoc options before file.md