Landon Curt Noll
c176b51cec
We export shell variables where needed. We print debug messages of shell variables in the order they were exported or declared, except for the USAGE shell variable, for those shell variables that were exported or declared prior to the set of debug messages of shell variables. Changed `bin/chk-entry.sh` VERSION from "1.1.3 2024-03-18" to "1.1.4 2024-03-26". Changed `bin/gen-authors.sh` VERSION from "1.3.1 2024-03-18" to "1.3.2 2024-03-26". Changed `bin/gen-location.sh` VERSION from "1.1.1 2024-03-18" to "1.1.2 2024-03-26". Changed `bin/gen-other-html.sh` VERSION from "1.0.1 2024-03-08" to "1.0.2 2024-03-26". Changed `bin/gen-sitemap.sh` VERSION from "1.3.2 2024-03-18" to "1.3.3 2024-03-26". Changed `bin/gen-status.sh` VERSION from "1.1.1 2024-03-18" to "1.1.2 2024-03-26". Changed `bin/gen-years.sh` VERSION from "1.0.2 2024-03-13" to "1.0.3 2024-03-26". Changed `bin/md2html.sh` VERSION from "1.1.1 2024-03-09" to "1.1.2 2024-03-26". Changed `bin/output-index-author.sh` VERSION from "1.5.1 2024-03-19" to "1.5.2 2024-03-26". Changed `bin/output-index-inventory.sh` VERSION from "1.2.2 2024-03-19" to "1.2.3 2024-03-26". Changed `bin/output-year-index.sh` VERSION from "1.1.1 2024-03-19" to "1.1.2 2024-03-26". Changed `bin/pandoc-wrapper.sh` VERSION from "1.5.2 2024-03-19" to "1.5.3 2024-03-26". Changed `bin/quick-readme2index.sh` VERSION from "1.1.2 2024-03-08" to "1.1.3 2024-03-26". Changed `bin/readme2index.sh` VERSION from "1.2.1 2024-02-23" to "1.2.2 2024-02-26". Changed `bin/sort.gitignore.sh` VERSION from "1.1.2 2024-03-18" to "1.1.3 2024-03-26". Changed `bin/status2html.sh` VERSION from "1.1.1 2024-03-19" to "1.1.2 2024-03-26". Changed `bin/subst.default.sh` VERSION from "1.2.1 2024-02-23" to "1.2.2 2024-02-26". Changed `bin/subst.entry-index.sh` VERSION from "1.3.1 2024-03-19" to "1.3.2 2024-03-26". Changed `bin/tar-all.sh` VERSION from "1.1.1 2024-03-18" to "1.1.2 2024-03-26". Changed `bin/tar-entry.sh` VERSION from "1.3.1 2024-03-25" to "1.3.2 2024-03-26". Changed `bin/tar-year.sh` VERSION from "1.1.1 2024-03-18" to "1.1.2 2024-03-26". Changed `bin/all-years.sh` VERSION from "1.0.1 2024-02-23" to "1.0.2 2024-02-26". Changed `bin/gen-top-html.sh` VERSION from "1.2.1 2024-03-08" to "1.2.2 2024-03-26". Changed `bin/gen-year-index.sh` VERSION from "1.0.3 2024-03-09" to "1.0.4 2024-03-26". Changed `bin/subst.year-index.sh` VERSION from "1.1.1 2024-03-19" to "1.1.2 2024-03-26". Changed `bin/untar-entry.sh` VERSION from "1.0 2024-03-25" to "1.0.1 2024-03-26".
861 lines
26 KiB
Bash
Executable File
861 lines
26 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
#
|
|
# gen-years.sh - create the top level years.html page
|
|
#
|
|
# Copyright (c) 2024 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 - run only with a bash that is version 5.1.8 or later
|
|
#
|
|
# The "/usr/bin/env bash" command must result in using a bash that
|
|
# is version 5.1.8 or later.
|
|
#
|
|
# We could relax this version and insist on version 4.2 or later. Versions
|
|
# of bash between 4.2 and 5.1.7 might work. However, to be safe, we will require
|
|
# bash version 5.1.8 or later.
|
|
#
|
|
# WHY 5.1.8 and not 4.2? This safely is done because macOS Homebrew bash we
|
|
# often use is "version 5.2.26(1)-release" or later, and the RHEL Linux bash we
|
|
# use often use is "version 5.1.8(1)-release" or later. These versions are what
|
|
# we initially tested. We recommend you either upgrade bash or install a newer
|
|
# version of bash and adjust your $PATH so that "/usr/bin/env bash" finds a bash
|
|
# that is version 5.1.8 or later.
|
|
#
|
|
# NOTE: The macOS shipped, as of 2024 March 15, a version of bash is something like
|
|
# bash "version 3.2.57(1)-release". That macOS shipped version of bash
|
|
# will NOT work. For users of macOS we recommend you install Homebrew,
|
|
# (see https://brew.sh), and then run "brew install bash" which will
|
|
# typically install it into /opt/homebrew/bin/bash, and then arrange your $PATH
|
|
# so that "/usr/bin/env bash" finds "/opt/homebrew/bin" (or whatever the
|
|
# Homebrew bash is).
|
|
#
|
|
# NOTE: And while MacPorts might work, we noticed a number of subtle differences
|
|
# with some of their ported tools to suggest you might be better off
|
|
# with installing Homebrew (see https://brew.sh). No disrespect is intended
|
|
# to the MacPorts team as they do a commendable job. Nevertheless we ran
|
|
# into enough differences with MacPorts environments to suggest you
|
|
# might find a better experience with this tool under Homebrew instead.
|
|
#
|
|
if [[ -z ${BASH_VERSINFO[0]} ||
|
|
${BASH_VERSINFO[0]} -lt 5 ||
|
|
${BASH_VERSINFO[0]} -eq 5 && ${BASH_VERSINFO[1]} -lt 1 ||
|
|
${BASH_VERSINFO[0]} -eq 5 && ${BASH_VERSINFO[1]} -eq 1 && ${BASH_VERSINFO[2]} -lt 8 ]]; then
|
|
echo "$0: ERROR: bash version needs to be >= 5.1.8: $BASH_VERSION" 1>&2
|
|
echo "$0: Warning: bash version >= 4.2 might work but 5.1.8 was the minimum we tested" 1>&2
|
|
echo "$0: Notice: For macOS users: install Homebrew (see https://brew.sh), then run" \
|
|
""brew install bash" and then modify your \$PATH so that \"#!/usr/bin/env bash\"" \
|
|
"finds the Homebrew installed (usually /opt/homebrew/bin/bash) version of bash" 1>&2
|
|
exit 4
|
|
fi
|
|
|
|
# setup bash file matching
|
|
#
|
|
# We must declare arrays with -ag or -Ag, and we need loops to "export" modified variables.
|
|
# This requires a bash with a version 4.2 or later. See the larger comment above about bash versions.
|
|
#
|
|
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 -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.3 2024-03-26"
|
|
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 5
|
|
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 TOPDIR
|
|
TAC_TOOL=$(type -P tac)
|
|
export TAC_TOOL
|
|
if [[ ! -x $TAC_TOOL ]]; then
|
|
echo "$0: FATAL: tac executable is not installed or not in \$PATH" 1>&2
|
|
exit 5
|
|
fi
|
|
FMT_TOOL=$(type -P fmt)
|
|
export FMT_TOOL
|
|
if [[ ! -x $FMT_TOOL ]]; then
|
|
echo "$0: FATAL: fmt executable is not installed or not in \$PATH" 1>&2
|
|
exit 5
|
|
fi
|
|
export DOCROOT_SLASH="./"
|
|
export TAGLINE="bin/$NAME"
|
|
export MD2HTML_SH="bin/md2html.sh"
|
|
export PANDOC_WRAPPER="bin/pandoc-wrapper.sh"
|
|
export REPO_URL="https://github.com/ioccc-src/temp-test-ioccc"
|
|
export SITE_URL="https://ioccc-src.github.io/temp-test-ioccc"
|
|
#
|
|
export NOOP=
|
|
export DO_NOT_PROCESS=
|
|
export EXIT_CODE="0"
|
|
|
|
# clear options we will add to tools
|
|
#
|
|
unset TOOL_OPTION
|
|
declare -ag TOOL_OPTION
|
|
|
|
# usage
|
|
#
|
|
export USAGE="usage: $0 [-h] [-v level] [-V] [-d topdir] [-D docroot/] [-n] [-N]
|
|
[-t tagline] [-T md2html.sh] [-p tool] [-u repo_url]
|
|
|
|
-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)
|
|
NOTE: The '-d topdir' is passed as leading options on tool command lines.
|
|
-D docroot/ set the document root path followed by slash (def: $DOCROOT_SLASH)
|
|
NOTE: The '-D docroot/' is passed as leading options on tool command lines.
|
|
NOTE: 'docroot' must end in a slash
|
|
|
|
-n go thru the actions, but do not update any files (def: do the action)
|
|
NOTE: -n is passed to tool
|
|
-N do not process anything, just parse arguments (def: process something)
|
|
|
|
-t tagline string to write about the tool that formed the markdown content (def: $TAGLINE)
|
|
NOTE: 'tagline' may be enclosed within, but may NOT contain an internal single-quote, or double-quote.
|
|
-T md2html.sh run 'markdown to html tool' to convert markdown into HTML (def: $MD2HTML_SH)
|
|
|
|
-p tool run 'pandoc wrapper tool' (not pandoc path) during HTML phase number 21 (def: use $PANDOC_WRAPPER)
|
|
NOTE: The '-p tool' is passed as leading options on tool command lines.
|
|
|
|
-u repo_url Base level URL of target git repo (def: $REPO_URL)
|
|
NOTE: The '-u repo_url' is passed as leading options on tool command lines.
|
|
-w site_url Base URL of the web site (def: $SITE_URL)
|
|
NOTE: The '-w site_url' is passed as leading options on tool command lines.
|
|
|
|
NOTE: The '-v level' is passed as initial command line options to the 'markdown to html tool' (md2html.sh).
|
|
The 'tagline' is passed as '-t tagline' to the 'markdown to html tool' (md2html.sh), after the '-v level'.
|
|
Any '-T md2html.sh', '-p tool', '-P pandoc_opts', '-u repo_url', '-U top_url'
|
|
are passed to the 'markdown to html tool' (md2html.sh), and will be before any command line arguments.
|
|
|
|
Exit codes:
|
|
0 all OK
|
|
1 some internal tool exited non-zero
|
|
2 -h and help string printed or -V and version string printed
|
|
3 command line error
|
|
4 bash version is too old
|
|
5 some internal tool is not found or not an executable file
|
|
6 problems found with or in the topdir or topdir/YYYY directory
|
|
7 problems found with or in the entry topdir/YYYY/dir directory
|
|
>= 10 internal error
|
|
|
|
$NAME version: $VERSION"
|
|
|
|
# output_award
|
|
#
|
|
# Write the award name 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 .entry.json file - XXX
|
|
# XXX - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - GROSS HACK - XXX
|
|
# XXX - XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - XXX
|
|
#
|
|
# usage:
|
|
# output_award YYYY/dir/.entry.json
|
|
#
|
|
# returns:
|
|
# 0 ==> no errors detected, but output may be empty
|
|
# > 0 ==> function error number
|
|
#
|
|
function output_award
|
|
{
|
|
local ENTRY_JSON_PATH; # the .entry.json path
|
|
local AWARD_STRING; # winning entry award string
|
|
|
|
# parse args
|
|
#
|
|
if [[ $# -ne 1 ]]; then
|
|
echo "$0: ERROR: in output_award: expected 1 arg, found $#" 1>&2
|
|
return 1
|
|
fi
|
|
ENTRY_JSON_PATH="$1"
|
|
if [[ ! -e $ENTRY_JSON_PATH ]]; then
|
|
echo "$0: ERROR: in output_award: .entry.json does not exist: $ENTRY_JSON_PATH" 1>&2
|
|
return 2
|
|
fi
|
|
if [[ ! -f $ENTRY_JSON_PATH ]]; then
|
|
echo "$0: ERROR: in output_award: .entry.json is not a file: $ENTRY_JSON_PATH" 1>&2
|
|
return 3
|
|
fi
|
|
if [[ ! -r $ENTRY_JSON_PATH ]]; then
|
|
echo "$0: ERROR: in output_award: .entry.json is not a readable file: $ENTRY_JSON_PATH" 1>&2
|
|
return 4
|
|
fi
|
|
|
|
# obtain the award string
|
|
#
|
|
AWARD_STRING=$(grep -F '"award" : "' "$ENTRY_JSON_PATH" | sed -e 's/^.*"award" : "//' -e 's/",//')
|
|
if [[ -z $AWARD_STRING ]]; then
|
|
echo "$0: ERROR: in output_award: no award found in .entry.json file: $ENTRY_JSON_PATH" 1>&2
|
|
return 5
|
|
fi
|
|
echo "$AWARD_STRING"
|
|
return 0
|
|
}
|
|
|
|
# output_ordinal
|
|
#
|
|
# Write the numerical ordinal form of a non-negative integer to standard output (stdout)
|
|
#
|
|
# usage:
|
|
# output_ordinal integer
|
|
#
|
|
# returns:
|
|
# 0 ==> no errors detected
|
|
# > 0 ==> function error number
|
|
#
|
|
function output_ordinal
|
|
{
|
|
local INTEGER; # integer argument
|
|
|
|
# parse args
|
|
#
|
|
if [[ $# -ne 1 ]]; then
|
|
echo "$0: ERROR: in output_ordinal: expected 1 arg, found $#" 1>&2
|
|
return 1
|
|
fi
|
|
INTEGER="$1"
|
|
if [[ $INTEGER =~ ^-?[0-9]+$ ]]; then
|
|
:
|
|
else
|
|
echo "$0: ERROR: argument is not an integer: $INTEGER" 1>&2
|
|
return 2
|
|
fi
|
|
if [[ $INTEGER -lt 0 ]]; then
|
|
echo "$0: ERROR: integer is negative: $INTEGER" 1>&2
|
|
return 3
|
|
fi
|
|
|
|
# case: 11, 12, 13 are N-th
|
|
#
|
|
if [[ $INTEGER -ge 11 && $INTEGER -le 13 ]]; then
|
|
echo "${INTEGER}th"
|
|
|
|
# case: 1 mod 10 is N-st
|
|
#
|
|
elif [[ $((INTEGER % 10)) -eq 1 ]]; then
|
|
echo "${INTEGER}st"
|
|
|
|
# case: 2 mod 10 is N-nd
|
|
#
|
|
elif [[ $((INTEGER % 10)) -eq 2 ]]; then
|
|
echo "${INTEGER}nd"
|
|
|
|
# case: 3 mod 10 is N-rd
|
|
#
|
|
elif [[ $((INTEGER % 10)) -eq 3 ]]; then
|
|
echo "${INTEGER}rd"
|
|
|
|
# case: everything else is N-th
|
|
#
|
|
else
|
|
echo "${INTEGER}th"
|
|
fi
|
|
return 0
|
|
}
|
|
|
|
# parse command line
|
|
#
|
|
while getopts :hv:Vd:D:nNt:T:p:u:w: flag; do
|
|
case "$flag" in
|
|
h) echo "$USAGE" 1>&2
|
|
exit 2
|
|
;;
|
|
v) V_FLAG="$OPTARG"
|
|
;;
|
|
V) echo "$VERSION"
|
|
exit 2
|
|
;;
|
|
d) TOPDIR="$OPTARG"
|
|
TOOL_OPTION+=("-d")
|
|
TOOL_OPTION+=("$TOPDIR")
|
|
;;
|
|
D) # parse -D docroot/
|
|
case "$OPTARG" in
|
|
*/) ;;
|
|
*) echo "$0: ERROR: in -D docroot/, the docroot must end in /" 1>&2
|
|
echo 1>&2
|
|
print_usage 1>&2
|
|
exit 3
|
|
;;
|
|
esac
|
|
DOCROOT_SLASH="$OPTARG"
|
|
# -D docroot/ always added after arg parsing
|
|
;;
|
|
n) NOOP="-n"
|
|
;;
|
|
N) DO_NOT_PROCESS="-N"
|
|
;;
|
|
t) # parse -t tagline
|
|
case "$OPTARG" in
|
|
*"'"*)
|
|
echo "$0: ERROR: in -t tagline, the tagline may not contain a single-quote character: $OPTARG" 1>&2
|
|
echo 1>&2
|
|
print_usage 1>&2
|
|
exit 3
|
|
;;
|
|
*'"'*)
|
|
echo "$0: ERROR: in -t tagline, the tagline may not contain a double-quote character: $OPTARG" 1>&2
|
|
echo 1>&2
|
|
print_usage 1>&2
|
|
exit 3
|
|
;;
|
|
*) ;;
|
|
esac
|
|
TAGLINE="$OPTARG"
|
|
# -t tagline always added after arg parsing
|
|
;;
|
|
T) MD2HTML_SH="$OPTARG"
|
|
TOOL_OPTION+=("-T")
|
|
TOOL_OPTION+=("$MD2HTML_SH")
|
|
;;
|
|
p) PANDOC_WRAPPER="$OPTARG"
|
|
TOOL_OPTION+=("-p")
|
|
TOOL_OPTION+=("$PANDOC_WRAPPER")
|
|
;;
|
|
u) REPO_URL="$OPTARG"
|
|
TOOL_OPTION+=("-u")
|
|
TOOL_OPTION+=("$REPO_URL")
|
|
;;
|
|
w) SITE_URL="$OPTARG"
|
|
TOOL_OPTION+=("-w")
|
|
TOOL_OPTION+=("$SITE_URL")
|
|
;;
|
|
\?) 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
|
|
|
|
# remove the options
|
|
#
|
|
shift $(( OPTIND - 1 ));
|
|
#
|
|
# verify arg count and parse args
|
|
#
|
|
if [[ $V_FLAG -ge 5 ]]; then
|
|
echo "$0: debug[5]: file argument count: $#" 1>&2
|
|
fi
|
|
#
|
|
if [[ $# -ne 0 ]]; then
|
|
echo "$0: ERROR: expected 0 args, found: $#" 1>&2
|
|
exit 3
|
|
fi
|
|
|
|
# always add the '-v level' option, unless level is empty, to the set of options passed to the md2html.sh tool
|
|
#
|
|
if [[ -n $V_FLAG ]]; then
|
|
TOOL_OPTION+=("-v")
|
|
TOOL_OPTION+=("$V_FLAG")
|
|
fi
|
|
|
|
# always add the '-t tagline' option, unless tagline is empty, to the set of options passed to the md2html.sh tool
|
|
#
|
|
if [[ -n $TAGLINE ]]; then
|
|
TOOL_OPTION+=("-t")
|
|
TOOL_OPTION+=("$TAGLINE")
|
|
fi
|
|
|
|
# always add the '-U URL' for the top level location.html file
|
|
#
|
|
TOOL_OPTION+=("-U")
|
|
TOOL_OPTION+=("$SITE_URL/years.html")
|
|
|
|
# always add the '-D docroot/' for the top level location.html file
|
|
#
|
|
TOOL_OPTION+=("-D")
|
|
TOOL_OPTION+=("$DOCROOT_SLASH")
|
|
|
|
# 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 6
|
|
fi
|
|
if [[ ! -e $TOPDIR ]]; then
|
|
echo "$0: ERROR: TOPDIR does not exist: $TOPDIR" 1>&2
|
|
echo "$0: Notice: if needed: $GIT_TOOL clone $REPO_URL; cd $REPO_NAME" 1>&2
|
|
exit 6
|
|
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 6
|
|
fi
|
|
|
|
# cd to topdir
|
|
#
|
|
if [[ ! -e $TOPDIR ]]; then
|
|
echo "$0: ERROR: cannot cd to non-existent path: $TOPDIR" 1>&2
|
|
exit 6
|
|
fi
|
|
if [[ ! -d $TOPDIR ]]; then
|
|
echo "$0: ERROR: cannot cd to a non-directory: $TOPDIR" 1>&2
|
|
exit 6
|
|
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 6
|
|
fi
|
|
if [[ $V_FLAG -ge 3 ]]; then
|
|
echo "$0: debug[3]: now in directory: $(/bin/pwd)" 1>&2
|
|
fi
|
|
|
|
# verify that we have an bin subdirectory
|
|
#
|
|
export BIN_PATH="$TOPDIR/bin"
|
|
if [[ ! -d $BIN_PATH ]]; then
|
|
echo "$0: ERROR: bin is not a directory under topdir: $BIN_PATH" 1>&2
|
|
exit 6
|
|
fi
|
|
export BIN_DIR="bin"
|
|
|
|
# verify we have a non-empty readable .top file
|
|
#
|
|
export TOP_FILE=".top"
|
|
if [[ ! -e $TOP_FILE ]]; then
|
|
echo "$0: ERROR: .top does not exist: $TOP_FILE" 1>&2
|
|
exit 6
|
|
fi
|
|
if [[ ! -f $TOP_FILE ]]; then
|
|
echo "$0: ERROR: .top is not a regular file: $TOP_FILE" 1>&2
|
|
exit 6
|
|
fi
|
|
if [[ ! -r $TOP_FILE ]]; then
|
|
echo "$0: ERROR: .top is not an readable file: $TOP_FILE" 1>&2
|
|
exit 6
|
|
fi
|
|
if [[ ! -s $TOP_FILE ]]; then
|
|
echo "$0: ERROR: .top is not a non-empty readable file: $TOP_FILE" 1>&2
|
|
exit 6
|
|
fi
|
|
|
|
# verify that the md2html tool is executable
|
|
#
|
|
if [[ ! -e $MD2HTML_SH ]]; then
|
|
echo "$0: ERROR: md2html.sh does not exist: $MD2HTML_SH" 1>&2
|
|
exit 5
|
|
fi
|
|
if [[ ! -f $MD2HTML_SH ]]; then
|
|
echo "$0: ERROR: md2html.sh is not a regular file: $MD2HTML_SH" 1>&2
|
|
exit 5
|
|
fi
|
|
if [[ ! -x $MD2HTML_SH ]]; then
|
|
echo "$0: ERROR: md2html.sh is not an executable file: $MD2HTML_SH" 1>&2
|
|
exit 5
|
|
fi
|
|
|
|
# note years.html file
|
|
#
|
|
export YEARS_HTML="years.html"
|
|
|
|
# print running info if verbose
|
|
#
|
|
# If -v 3 or higher, print exported variables in order that they were exported.
|
|
#
|
|
if [[ $V_FLAG -ge 3 ]]; then
|
|
echo "$0: debug[3]: VERSION=$VERSION" 1>&2
|
|
echo "$0: debug[3]: NAME=$NAME" 1>&2
|
|
echo "$0: debug[3]: V_FLAG=$V_FLAG" 1>&2
|
|
echo "$0: debug[3]: GIT_TOOL=$GIT_TOOL" 1>&2
|
|
echo "$0: debug[3]: TOPDIR=$TOPDIR" 1>&2
|
|
echo "$0: debug[3]: TAC_TOOL=$TAC_TOOL" 1>&2
|
|
echo "$0: debug[3]: FMT_TOOL=$FMT_TOOL" 1>&2
|
|
echo "$0: debug[3]: DOCROOT_SLASH=$DOCROOT_SLASH" 1>&2
|
|
echo "$0: debug[3]: TAGLINE=$TAGLINE" 1>&2
|
|
echo "$0: debug[3]: MD2HTML_SH=$MD2HTML_SH" 1>&2
|
|
echo "$0: debug[3]: PANDOC_WRAPPER=$PANDOC_WRAPPER" 1>&2
|
|
echo "$0: debug[3]: REPO_URL=$REPO_URL" 1>&2
|
|
echo "$0: debug[3]: SITE_URL=$SITE_URL" 1>&2
|
|
echo "$0: debug[3]: NOOP=$NOOP" 1>&2
|
|
echo "$0: debug[3]: DO_NOT_PROCESS=$DO_NOT_PROCESS" 1>&2
|
|
echo "$0: debug[3]: EXIT_CODE=$EXIT_CODE" 1>&2
|
|
for index in "${!TOOL_OPTION[@]}"; do
|
|
echo "$0: debug[3]: TOOL_OPTION[$index]=${TOOL_OPTION[$index]}" 1>&2
|
|
done
|
|
echo "$0: debug[3]: REPO_NAME=$REPO_NAME" 1>&2
|
|
echo "$0: debug[3]: CD_FAILED=$CD_FAILED" 1>&2
|
|
echo "$0: debug[3]: BIN_PATH=$BIN_PATH" 1>&2
|
|
echo "$0: debug[3]: BIN_DIR=$BIN_DIR" 1>&2
|
|
echo "$0: debug[3]: TOP_FILE=$TOP_FILE" 1>&2
|
|
echo "$0: debug[3]: YEARS_HTML=$YEARS_HTML" 1>&2
|
|
fi
|
|
|
|
# -N stops early before any processing is performed
|
|
#
|
|
if [[ -n $DO_NOT_PROCESS ]]; then
|
|
if [[ $V_FLAG -ge 3 ]]; then
|
|
echo "$0: debug[3]: arguments parsed, -N given, exiting 0" 1>&2
|
|
fi
|
|
exit 0
|
|
fi
|
|
|
|
# create a temporary years markdown file
|
|
#
|
|
export TMP_YEARS_MD=".$NAME.$$.years.md"
|
|
if [[ $V_FLAG -ge 3 ]]; then
|
|
echo "$0: debug[3]: temporary years markdown file: $TMP_YEARS_MD" 1>&2
|
|
fi
|
|
if [[ -z $NOOP ]]; then
|
|
trap 'rm -f $TMP_YEARS_MD; exit' 0 1 2 3 15
|
|
rm -f "$TMP_YEARS_MD"
|
|
if [[ -e $TMP_YEARS_MD ]]; then
|
|
echo "$0: ERROR: cannot remove temporary years markdown file: $TMP_YEARS_MD" 1>&2
|
|
exit 10
|
|
fi
|
|
:> "$TMP_YEARS_MD"
|
|
if [[ ! -e $TMP_YEARS_MD ]]; then
|
|
echo "$0: ERROR: cannot create temporary years markdown file: $TMP_YEARS_MD" 1>&2
|
|
exit 11
|
|
fi
|
|
elif [[ $V_FLAG -ge 3 ]]; then
|
|
echo "$0: debug[3]: because of -n, temporary years markdown file is not used: $TMP_YEARS_MD" 1>&2
|
|
fi
|
|
|
|
# write All IOCCC years markdown data
|
|
#
|
|
{
|
|
# write All IOCCC heading lines
|
|
#
|
|
cat << EOF
|
|
# IOCCC Winning Entries by Year
|
|
|
|
## All IOCCC years
|
|
|
|
**Download IOCCC** [all entry source](ioccc.tar.bz2)
|
|
|
|
### Jump to:
|
|
EOF
|
|
|
|
# write jump to table of years
|
|
#
|
|
"$TAC_TOOL" "$TOP_FILE" |
|
|
sed -e 's/^.*$/[&](#&)/' |
|
|
"$FMT_TOOL" -w 120 |
|
|
sed -e 's/ / | /g' -e 's/$/<br><br>/' -e '$s/<br><br>//'
|
|
echo
|
|
|
|
} | if [[ -z $NOOP ]]; then
|
|
cat >> "$TMP_YEARS_MD"
|
|
else
|
|
cat > /dev/null
|
|
if [[ $V_FLAG -ge 3 ]]; then
|
|
echo "$0: debug[3]: because of -n, All IOCCC years markdown data NOT written into: $TMP_YEARS_MD" 1>&2
|
|
fi
|
|
fi
|
|
|
|
# write markdown for each IOCCC year in reverse order
|
|
#
|
|
YEAR_COUNT=$(wc -l < "$TOP_FILE" | sed -e 's/[[:space:]]//g')
|
|
export YEAR_COUNT
|
|
export YYYY
|
|
for YYYY in $("$TAC_TOOL" "$TOP_FILE"); do
|
|
|
|
# debug YYYY
|
|
#
|
|
if [[ $V_FLAG -ge 1 ]]; then
|
|
echo "$0: debug[1]: using: $TOP_FILE starting to process year: $YYYY" 1>&2
|
|
fi
|
|
|
|
# verify that YYYY is a readable directory
|
|
#
|
|
if [[ ! -e $YYYY ]]; then
|
|
echo "$0: ERROR: YYYY does not exist: $YYYY" 1>&2
|
|
EXIT_CODE="6" # exit 6
|
|
echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2
|
|
continue
|
|
fi
|
|
if [[ ! -d $YYYY ]]; then
|
|
echo "$0: ERROR: YYYY is not a directory: $YYYY" 1>&2
|
|
EXIT_CODE="6" # exit 6
|
|
echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2
|
|
continue
|
|
fi
|
|
if [[ ! -r $YYYY ]]; then
|
|
echo "$0: ERROR: YYYY is not an readable directory: $YYYY" 1>&2
|
|
EXIT_CODE="6" # exit 6
|
|
echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2
|
|
continue
|
|
fi
|
|
|
|
# verify that YYYY has a non-empty readable .year file
|
|
#
|
|
export YEAR_FILE="$YYYY/.year"
|
|
if [[ ! -e $YEAR_FILE ]]; then
|
|
echo "$0: ERROR: YYYY/.year does not exist: $YEAR_FILE" 1>&2
|
|
EXIT_CODE="6" # exit 6
|
|
echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2
|
|
continue
|
|
fi
|
|
if [[ ! -f $YEAR_FILE ]]; then
|
|
echo "$0: ERROR: YYYY/.year is not a regular file: $YEAR_FILE" 1>&2
|
|
EXIT_CODE="6" # exit 6
|
|
echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2
|
|
continue
|
|
fi
|
|
if [[ ! -r $YEAR_FILE ]]; then
|
|
echo "$0: ERROR: YYYY/.year is not an readable file: $YEAR_FILE" 1>&2
|
|
EXIT_CODE="6" # exit 6
|
|
echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2
|
|
continue
|
|
fi
|
|
if [[ ! -s $YEAR_FILE ]]; then
|
|
echo "$0: ERROR: YYYY/.year is not a non-empty readable file: $YEAR_FILE" 1>&2
|
|
EXIT_CODE="6" # exit 6
|
|
echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2
|
|
continue
|
|
fi
|
|
|
|
# write leading markdown for this IOCCC year
|
|
#
|
|
{
|
|
ORDINAL=$(output_ordinal "$YEAR_COUNT")
|
|
echo "## <a name=$YYYY></a>$YYYY - The $ORDINAL IOCCC"
|
|
echo
|
|
echo "**Download IOCCC** [$YYYY entry source]($YYYY/ioccc.$YYYY.tar.bz2)"
|
|
echo
|
|
} | if [[ -z $NOOP ]]; then
|
|
cat >> "$TMP_YEARS_MD"
|
|
else
|
|
cat > /dev/null
|
|
if [[ $V_FLAG -ge 3 ]]; then
|
|
echo "$0: debug[3]: because of -n, IOCCC year $YYYY starting markdown data is NOT written into: $TMP_YEARS_MD" 1>&2
|
|
fi
|
|
fi
|
|
|
|
# process each entry under YYYY
|
|
#
|
|
export YYYY_DIR
|
|
for YYYY_DIR in $(< "$YEAR_FILE"); do
|
|
|
|
# debug YYYY
|
|
#
|
|
if [[ $V_FLAG -ge 3 ]]; then
|
|
echo "$0: debug[3]: starting to process year/dir: $YYYY_DIR" 1>&2
|
|
fi
|
|
|
|
# parse YYYY_DIR
|
|
#
|
|
if [[ ! -d $YYYY_DIR ]]; then
|
|
echo "$0: ERROR: YYYY_DIR is not a directory: $YYYY_DIR" 1>&2
|
|
EXIT_CODE="7" # exit 7
|
|
echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2
|
|
continue
|
|
fi
|
|
if [[ ! -w $YYYY_DIR ]]; then
|
|
echo "$0: ERROR: YYYY_DIR is not a writable directory: $YYYY_DIR" 1>&2
|
|
EXIT_CODE="7" # exit 7
|
|
echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2
|
|
continue
|
|
fi
|
|
export YEAR_DIR=${YYYY_DIR%%/*}
|
|
if [[ -z $YEAR_DIR ]]; then
|
|
echo "$0: ERROR: YYYY_DIR not in YYYY/dir form: $YYYY_DIR" 1>&2
|
|
EXIT_CODE="7" # exit 7
|
|
echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2
|
|
continue
|
|
fi
|
|
export ENTRY_DIR=${YYYY_DIR#*/}
|
|
if [[ -z $ENTRY_DIR ]]; then
|
|
echo "$0: ERROR: YYYY_DIR not in $YEAR_DIR/dir form: $YYYY_DIR" 1>&2
|
|
EXIT_CODE="7" # exit 7
|
|
echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2
|
|
continue
|
|
fi
|
|
if [[ $ENTRY_DIR = */* ]]; then
|
|
echo "$0: ERROR: YYYY_DIR: $YYYY_DIR dir contains a /: $ENTRY_DIR" 1>&2
|
|
EXIT_CODE="7" # exit 7
|
|
echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2
|
|
continue
|
|
fi
|
|
|
|
# verify that YYYY_DIR is a writable directory
|
|
#
|
|
if [[ ! -e $YYYY_DIR ]]; then
|
|
echo "$0: ERROR: YYYY_DIR does not exist: $YYYY_DIR" 1>&2
|
|
EXIT_CODE="7" # exit 7
|
|
echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2
|
|
continue
|
|
fi
|
|
if [[ ! -d $YYYY_DIR ]]; then
|
|
echo "$0: ERROR: YYYY_DIR is not a directory: $YYYY_DIR" 1>&2
|
|
EXIT_CODE="7" # exit 7
|
|
echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2
|
|
continue
|
|
fi
|
|
if [[ ! -w $YYYY_DIR ]]; then
|
|
echo "$0: ERROR: YYYY_DIR is not an writable directory: $YYYY_DIR" 1>&2
|
|
EXIT_CODE="7" # exit 7
|
|
echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2
|
|
continue
|
|
fi
|
|
|
|
# verify YYYY/dir/.path
|
|
#
|
|
export DOT_PATH="$YYYY_DIR/.path"
|
|
if [[ ! -s $DOT_PATH ]]; then
|
|
echo "$0: ERROR: not a non-empty file: $DOT_PATH" 1>&2
|
|
EXIT_CODE="7" # exit 7
|
|
echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2
|
|
continue
|
|
fi
|
|
DOT_PATH_CONTENT=$(< "$DOT_PATH")
|
|
if [[ $YYYY_DIR != "$DOT_PATH_CONTENT" ]]; then
|
|
echo "$0: ERROR: arg: $YYYY_DIR does not match $DOT_PATH contents: $DOT_PATH_CONTENT" 1>&2
|
|
EXIT_CODE="7" # exit 7
|
|
echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2
|
|
continue
|
|
fi
|
|
export ENTRY_JSON="$YYYY_DIR/.entry.json"
|
|
if [[ ! -e $ENTRY_JSON ]]; then
|
|
echo "$0: ERROR: .entry.json does not exist: $ENTRY_JSON" 1>&2
|
|
EXIT_CODE="7" # exit 7
|
|
echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2
|
|
continue
|
|
fi
|
|
if [[ ! -f $ENTRY_JSON ]]; then
|
|
echo "$0: ERROR: .entry.json is not a file: $ENTRY_JSON" 1>&2
|
|
EXIT_CODE="7" # exit 7
|
|
echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2
|
|
continue
|
|
fi
|
|
if [[ ! -r $ENTRY_JSON ]]; then
|
|
echo "$0: ERROR: .entry.json is not a readable file: $ENTRY_JSON" 1>&2
|
|
EXIT_CODE="7" # exit 7
|
|
echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2
|
|
continue
|
|
fi
|
|
|
|
# determine the award for this entry
|
|
#
|
|
AWARD=$(output_award "$ENTRY_JSON")
|
|
if [[ -z $AWARD ]]; then
|
|
echo "$0: ERROR: cannot find award in .entry.json: $ENTRY_JSON" 1>&2
|
|
EXIT_CODE="7" # exit 7
|
|
echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2
|
|
continue
|
|
fi
|
|
|
|
# output markdown for this entry
|
|
#
|
|
echo "* [$YYYY_DIR]($YYYY_DIR/index.html) - $AWARD"
|
|
done | if [[ -z $NOOP ]]; then
|
|
cat >> "$TMP_YEARS_MD"
|
|
else
|
|
cat > /dev/null
|
|
if [[ $V_FLAG -ge 3 ]]; then
|
|
echo "$0: debug[3]: because of -n, markdown data is NOT written into: $TMP_YEARS_MD" 1>&2
|
|
fi
|
|
fi
|
|
|
|
# write trailing markdown for this IOCCC year
|
|
#
|
|
{
|
|
echo
|
|
echo ' **Jump to:** [top](#)'
|
|
echo
|
|
} | if [[ -z $NOOP ]]; then
|
|
cat >> "$TMP_YEARS_MD"
|
|
else
|
|
cat > /dev/null
|
|
if [[ $V_FLAG -ge 3 ]]; then
|
|
echo "$0: debug[3]: because of -n, IOCCC year $YYYY ending markdown data is NOT written into: $TMP_YEARS_MD" 1>&2
|
|
fi
|
|
fi
|
|
|
|
# count down this year
|
|
#
|
|
((--YEAR_COUNT))
|
|
done
|
|
|
|
# use the md2html.sh tool to form a location HTML file, unless -n
|
|
#
|
|
if [[ -z $NOOP ]]; then
|
|
if [[ $V_FLAG -ge 1 ]]; then
|
|
echo "$0: debug[1]: about to run: $MD2HTML_SH ${TOOL_OPTION[*]} -- years.md $TMP_YEARS_MD $YEARS_HTML" 1>&2
|
|
fi
|
|
"$MD2HTML_SH" "${TOOL_OPTION[@]}" -- years.md "$TMP_YEARS_MD" "$YEARS_HTML"
|
|
status="$?"
|
|
if [[ $status -ne 0 ]]; then
|
|
echo "$0: Warning: md2html.sh: $MD2HTML_SH ${TOOL_OPTION[*]} -- years.md $TMP_YEARS_MD $YEARS_HTML" \
|
|
"failed, error: $status" 1>&2
|
|
EXIT_CODE="1" # exit 1
|
|
echo "$0: Warning: EXIT_CODE set to: $EXIT_CODE" 1>&2
|
|
elif [[ $V_FLAG -ge 3 ]]; then
|
|
echo "$0: debug[3]: now up to date: $YEARS_HTML" 1>&2
|
|
fi
|
|
|
|
# report disabled by -n
|
|
#
|
|
elif [[ $V_FLAG -ge 5 ]]; then
|
|
echo "$0: debug[5]: because of -n, did not run: $MD2HTML_SH ${TOOL_OPTION[*]} -- years.md $TMP_YEARS_MD $YEARS_HTML" 1>&2
|
|
fi
|
|
|
|
# file cleanup
|
|
#
|
|
if [[ -z $NOOP ]]; then
|
|
rm -f -- "$TMP_YEARS_MD"
|
|
elif [[ $V_FLAG -ge 3 ]]; then
|
|
echo "$0: debug[3]: because of -n, disabled: rm -f -- $TMP_YEARS_MD" 1>&2
|
|
fi
|
|
|
|
# All Done!!! -- Jessica Noll, Age 2
|
|
#
|
|
exit 0
|