create new status.json model
Changed the model of `status.json` model.
Updated `status.json` IOCCC_status_version from "0.2 2023-05-22"
to "1.0 2024-03-09".
Updated FAQ 2.6, improving how IOCCC entries announced.
Moved `bin/ioccc-status.sh` to `tmp/ioccc-status.sh`
now that we have a new status.json model for
which this tool no longer fits (sorry tm Canada 🇨🇦).
Added `status.md` markdown to explain the `status.json` model.
Added `status.html` to both display the contents of `status.json`
and render the contents of `status.md` as HTML.
Added `bin/status2html.sh` to convert `status.json`
into HTML for the `status.html` file.
Added `bin/gen-status.sh` to form `status.json`
and `status.html` files.
Added `make gen_status` to top level Makefile.
Performed `make www` to complete all of the above.
This commit is contained in:
Landon Curt Noll committed
1 parent
17f6da63b2
commit
ffb738af07
410 files changed
+2476
-474
No files matched your search
+28
-10
@@ -112,6 +112,26 @@ bin/gen-sitemap.sh -v 1
|
||||
```
|
||||
|
||||
|
||||
### [gen-status.sh](gen-status.sh)
|
||||
|
||||
Generate `status.json` according to the modification dates of `status.json`
|
||||
and `news.html`.
|
||||
|
||||
Without argument, the _contest_status_ is unchanged.
|
||||
|
||||
Usage:
|
||||
|
||||
```sh
|
||||
bin/gen-status.sh -v 1
|
||||
```
|
||||
|
||||
To force the _contest_status_ to be closed:
|
||||
|
||||
```sh
|
||||
bin/gen-status.sh -v 1 closed
|
||||
```
|
||||
|
||||
|
||||
### [gen-top-html.sh](gen-top-html.sh)
|
||||
|
||||
Generate a number of top level HTML pages for the IOCCC web sites.
|
||||
@@ -160,16 +180,6 @@ bin/gen-years.sh -v 1
|
||||
```
|
||||
|
||||
|
||||
### [ioccc-status.sh](ioccc-status)
|
||||
|
||||
Updates the [status.json](../status.json) file.
|
||||
|
||||
|
||||
### [manifest.entry.json.awk](manifest.entry.json.awk)
|
||||
|
||||
Output manifest table from a entry .entry.json file.
|
||||
|
||||
|
||||
### [md2html.sh](md2html.sh)
|
||||
|
||||
This is the primary tool that forms IOCCC generated HTML content from
|
||||
@@ -236,6 +246,14 @@ bin/all-run.sh -v 3 bin/readme2index.sh -v 1
|
||||
Convert a entry index.html into entry directory index.html.
|
||||
|
||||
|
||||
### [status2html.sh](status2html.sh)
|
||||
|
||||
Convert `status.json` into HTML.
|
||||
|
||||
This tool is a 'before tool' (-b tool) that is intended
|
||||
to be used by `bin/gen-status.sh`.
|
||||
|
||||
|
||||
### [sgi.sh](sgi.sh)
|
||||
|
||||
Sort .gitignore content from stdin to stdout.
|
||||
|
||||
Executable
+755
@@ -0,0 +1,755 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# gen-status.sh - create the top level status.md and status.html files
|
||||
#
|
||||
# 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 - must be bash with a version 4.2 or later
|
||||
#
|
||||
# We must declare arrays with -ag or -Ag, and we need loops to "export" modified variables.
|
||||
#
|
||||
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 2024-03-09"
|
||||
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
|
||||
export DOCROOT_SLASH="./"
|
||||
export TAGLINE="bin/$NAME"
|
||||
export MD2HTML_SH="bin/md2html.sh"
|
||||
export REPO_URL="https://github.com/ioccc-src/temp-test-ioccc"
|
||||
export SITE_URL="https://ioccc-src.github.io/temp-test-ioccc"
|
||||
JPARSE_TOOL=$(type -P jparse)
|
||||
export JPARSE_TOOL
|
||||
if [[ -z "$JPARSE_TOOL" ]]; then
|
||||
echo "$0: FATAL: jparse tool is not installed or not in \$PATH" 1>&2
|
||||
exit 5
|
||||
fi
|
||||
export IOCCC_STATUS_VERSION="1.0 2024-03-09"
|
||||
#
|
||||
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] [-n] [-N]
|
||||
[-t tagline] [-T md2html.sh] [-u repo_url]
|
||||
[p | pending | o | open | j | judging | c | closed]
|
||||
|
||||
-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)
|
||||
|
||||
-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.
|
||||
|
||||
[p | pending] Set the contest_status to pending
|
||||
[o | open] Set the contest_status to open
|
||||
[j | judging] Set the contest_status to judging
|
||||
[c | closed] Set the contest_status to closed
|
||||
(def: do not change contest_status)
|
||||
|
||||
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 file is not found, not a readable file or is malformed
|
||||
2 -h and help string printed or -V and version string printed
|
||||
3 command line error
|
||||
4 bash version is < 4.2
|
||||
5 some internal tool is not found or not an executable file
|
||||
6 problems found with or in the topdir or topdir/YYYY directory
|
||||
>= 10 internal error
|
||||
|
||||
$NAME version: $VERSION"
|
||||
|
||||
# output_mod_date
|
||||
#
|
||||
# output file modification date in UTC timezone in %FT%T+00:00 format
|
||||
#
|
||||
function output_mod_date
|
||||
{
|
||||
local FILENAME; # filename to obtain mod date
|
||||
local LS_OUTPUT; # output of the ls(1) command
|
||||
|
||||
# parse args
|
||||
#
|
||||
if [[ $# -ne 1 ]]; then
|
||||
echo "$0: ERROR: in output_mod_date expected 1 arg, found $#" 1>&2
|
||||
return 1
|
||||
fi
|
||||
FILENAME="$1"
|
||||
if [[ ! -e $FILENAME ]]; then
|
||||
echo "$0: ERROR: in output_mod_date: filename arg does not exist: $FILENAME" 1>&2
|
||||
return 3
|
||||
fi
|
||||
if [[ ! -r $FILENAME ]]; then
|
||||
echo "$0: ERROR: in output_mod_date: filename arg is not a readable: $FILENAME" 1>&2
|
||||
return 5
|
||||
fi
|
||||
|
||||
# obtain ls output
|
||||
#
|
||||
LS_OUTPUT=$(TZ=UTC ls -D '%FT%T+00:00' -ld "$FILENAME" 2>/dev/null)
|
||||
status="$?"
|
||||
if [[ $status -ne 0 ]]; then
|
||||
echo "$0: ERROR: in output_mod_date: TZ=UTC ls -D '%FT%T+00:00' -ld $FILENAME failed, error: $status" 1>&2
|
||||
return 6
|
||||
fi
|
||||
if [[ -z $LS_OUTPUT ]]; then
|
||||
echo "$0: ERROR: in output_mod_date: TZ=UTC ls -D '%FT%T+00:00' -ld $FILENAME output is empty" 1>&2
|
||||
return 7
|
||||
fi
|
||||
|
||||
# extract the date string and write it to standard output
|
||||
#
|
||||
awk '{print $6;}' <<< "$LS_OUTPUT"
|
||||
return 0;
|
||||
}
|
||||
|
||||
# output_status_json
|
||||
#
|
||||
# write an status.json file to standard output (stdout)
|
||||
#
|
||||
# usage:
|
||||
# output_status_json contest_status news.html status.json
|
||||
#
|
||||
# returns:
|
||||
# 0 ==> no errors detected, but output may be empty
|
||||
# > 0 ==> function error number
|
||||
#
|
||||
function output_status_json
|
||||
{
|
||||
local IOCCC_STATUS; # IOCCC contest_status arg
|
||||
local NEWS_PATH; # news.html file path
|
||||
local STATUS_PATH; # status.json file path
|
||||
local NEWS_MOD_DATE; # modification date of news.html
|
||||
local STATUS_MOD_DATE; # modification date of status.json
|
||||
|
||||
# parse args
|
||||
#
|
||||
if [[ $# -ne 3 ]]; then
|
||||
echo "$0: ERROR: in output_status_json: expected 3 args, found $#" 1>&2
|
||||
return 1
|
||||
fi
|
||||
IOCCC_STATUS="$1"
|
||||
if [[ -z $IOCCC_STATUS ]]; then
|
||||
echo "$0: ERROR: in output_status_json: contest_status arg is empty" 1>&2
|
||||
return 2
|
||||
fi
|
||||
NEWS_PATH="$2"
|
||||
if [[ ! -e $NEWS_PATH ]]; then
|
||||
echo "$0: ERROR: in output_status_json: news.html arg does not exist: $NEWS_PATH" 1>&2
|
||||
return 3
|
||||
fi
|
||||
if [[ ! -f $NEWS_PATH ]]; then
|
||||
echo "$0: ERROR: in output_status_json: news.html arg is not a file: $NEWS_PATH" 1>&2
|
||||
return 4
|
||||
fi
|
||||
if [[ ! -r $NEWS_PATH ]]; then
|
||||
echo "$0: ERROR: in output_status_json: news.html arg is not a readable file: $NEWS_PATH" 1>&2
|
||||
return 5
|
||||
fi
|
||||
STATUS_PATH="$3"
|
||||
if [[ ! -e $STATUS_PATH ]]; then
|
||||
echo "$0: ERROR: in output_status_json: news.html arg does not exist: $STATUS_PATH" 1>&2
|
||||
return 6
|
||||
fi
|
||||
if [[ ! -f $STATUS_PATH ]]; then
|
||||
echo "$0: ERROR: in output_status_json: news.html arg is not a file: $STATUS_PATH" 1>&2
|
||||
return 7
|
||||
fi
|
||||
if [[ ! -r $STATUS_PATH ]]; then
|
||||
echo "$0: ERROR: in output_status_json: news.html arg is not a readable file: $STATUS_PATH" 1>&2
|
||||
return 8
|
||||
fi
|
||||
|
||||
# obtain news.html file modification date
|
||||
#
|
||||
NEWS_MOD_DATE=$(output_mod_date "$NEWS_PATH")
|
||||
status="$?"
|
||||
if [[ $status -ne 0 ]]; then
|
||||
echo "$0: ERROR: in output_status_json: modification date of $NEWS_PATH failed, error: $status" 1>&2
|
||||
return 9
|
||||
fi
|
||||
if [[ -z $NEWS_MOD_DATE ]]; then
|
||||
echo "$0: ERROR: in output_status_json: modification date of $NEWS_PATH is empty" 1>&2
|
||||
return 10
|
||||
fi
|
||||
|
||||
# obtain status.json file modification date
|
||||
#
|
||||
STATUS_MOD_DATE=$(output_mod_date "$STATUS_PATH")
|
||||
status="$?"
|
||||
if [[ $status -ne 0 ]]; then
|
||||
echo "$0: ERROR: in output_status_json: modification date of $STATUS_PATH failed, error: $status" 1>&2
|
||||
return 11
|
||||
fi
|
||||
if [[ -z $STATUS_MOD_DATE ]]; then
|
||||
echo "$0: ERROR: in output_status_json: modification date of $STATUS_PATH is empty" 1>&2
|
||||
return 12
|
||||
fi
|
||||
|
||||
# output json
|
||||
#
|
||||
echo '{'
|
||||
echo ' "no_comment" : "mandatory comment: because comments were removed from the original JSON spec",'
|
||||
echo " \"IOCCC_status_version\" : \"$IOCCC_STATUS_VERSION\","
|
||||
echo " \"contest_status\" : \"$IOCCC_STATUS\","
|
||||
echo " \"news_update\" : \"$NEWS_MOD_DATE\","
|
||||
echo " \"status_update\" : \"$STATUS_MOD_DATE\""
|
||||
echo '}'
|
||||
return 0
|
||||
}
|
||||
|
||||
# parse command line
|
||||
#
|
||||
while getopts :hv:Vd:D:nNt:T: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")
|
||||
;;
|
||||
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 [[ $# -gt 1 ]]; then
|
||||
echo "$0: ERROR: expected 0 or 1 args, found: $#" 1>&2
|
||||
exit 3
|
||||
fi
|
||||
export CONTEST_STATUS=
|
||||
if [[ $# -eq 1 ]]; then
|
||||
case "$1" in
|
||||
p|pending) CONTEST_STATUS="pending"
|
||||
;;
|
||||
o|open) CONTEST_STATUS="open"
|
||||
;;
|
||||
j|judging) CONTEST_STATUS="judging"
|
||||
;;
|
||||
c|closed) CONTEST_STATUS="closed"
|
||||
;;
|
||||
*) echo "$0: ERROR: unexpected status arg: $1" 1>&2
|
||||
echo 1>&2
|
||||
echo "$USAGE" 1>&2
|
||||
exit 3
|
||||
;;
|
||||
esac
|
||||
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 status.html file
|
||||
#
|
||||
TOOL_OPTION+=("-U")
|
||||
TOOL_OPTION+=("$SITE_URL/status.html")
|
||||
|
||||
# always add the '-D docroot/' for the top level status.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 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
|
||||
|
||||
# verify readable non-empty news.html file
|
||||
#
|
||||
export NEWS_HTML="news.html"
|
||||
if [[ ! -e $NEWS_HTML ]]; then
|
||||
echo "$0: ERROR: news.html does not exist: $NEWS_HTML" 1>&2
|
||||
exit 1
|
||||
fi
|
||||
if [[ ! -f $NEWS_HTML ]]; then
|
||||
echo "$0: ERROR: news.html is not a regular file: $NEWS_HTML" 1>&2
|
||||
exit 1
|
||||
fi
|
||||
if [[ ! -r $NEWS_HTML ]]; then
|
||||
echo "$0: ERROR: news.html is not an executable file: $NEWS_HTML" 1>&2
|
||||
exit 1
|
||||
fi
|
||||
if [[ ! -s $NEWS_HTML ]]; then
|
||||
echo "$0: ERROR: news.html is not an executable file: $NEWS_HTML" 1>&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# verify readable non-empty status.json file
|
||||
#
|
||||
export STATUS_JSON="status.json"
|
||||
if [[ ! -e $STATUS_JSON ]]; then
|
||||
echo "$0: ERROR: status.json does not exist: $STATUS_JSON" 1>&2
|
||||
exit 1
|
||||
fi
|
||||
if [[ ! -f $STATUS_JSON ]]; then
|
||||
echo "$0: ERROR: status.json is not a regular file: $STATUS_JSON" 1>&2
|
||||
exit 1
|
||||
fi
|
||||
if [[ ! -r $STATUS_JSON ]]; then
|
||||
echo "$0: ERROR: status.json is not an executable file: $STATUS_JSON" 1>&2
|
||||
exit 1
|
||||
fi
|
||||
if [[ ! -s $STATUS_JSON ]]; then
|
||||
echo "$0: ERROR: status.json is not an executable file: $STATUS_JSON" 1>&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# verify readable non-empty status.md file
|
||||
#
|
||||
export STATUS_MD="status.md"
|
||||
if [[ ! -e $STATUS_MD ]]; then
|
||||
echo "$0: ERROR: status.md does not exist: $STATUS_MD" 1>&2
|
||||
exit 1
|
||||
fi
|
||||
if [[ ! -f $STATUS_MD ]]; then
|
||||
echo "$0: ERROR: status.md is not a regular file: $STATUS_MD" 1>&2
|
||||
exit 1
|
||||
fi
|
||||
if [[ ! -r $STATUS_MD ]]; then
|
||||
echo "$0: ERROR: status.md is not an executable file: $STATUS_MD" 1>&2
|
||||
exit 1
|
||||
fi
|
||||
if [[ ! -s $STATUS_MD ]]; then
|
||||
echo "$0: ERROR: status.md is not an executable file: $STATUS_MD" 1>&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# note status.html file
|
||||
#
|
||||
export STATUS_HTML="status.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]: 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]: CONTEST_STATUS=$CONTEST_STATUS" 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]: JPARSE_TOOL=$JPARSE_TOOL" 1>&2
|
||||
echo "$0: debug[3]: NOOP=$NOOP" 1>&2
|
||||
echo "$0: debug[3]: DOCROOT_SLASH=$DOCROOT_SLASH" 1>&2
|
||||
echo "$0: debug[3]: EXIT_CODE=$EXIT_CODE" 1>&2
|
||||
echo "$0: debug[3]: REPO_NAME=$REPO_NAME" 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]: NEWS_HTML=$NEWS_HTML" 1>&2
|
||||
echo "$0: debug[3]: STATUS_JSON=$STATUS_JSON" 1>&2
|
||||
echo "$0: debug[3]: STATUS_MD=$STATUS_MD" 1>&2
|
||||
echo "$0: debug[3]: STATUS_HTML=$STATUS_HTML" 1>&2
|
||||
fi
|
||||
|
||||
# validate JSON in status.json
|
||||
#
|
||||
"$JPARSE_TOOL" -q "$STATUS_JSON"
|
||||
status="$?"
|
||||
if [[ $status -ne 0 ]]; then
|
||||
echo "$0: ERROR: status.json is not valid JSON, jparse error code: $status" 1>&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# obtain contest_status if CONTEST_STATUS was not set in the arg
|
||||
#
|
||||
# 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
|
||||
#
|
||||
if [[ -z $CONTEST_STATUS ]]; then
|
||||
CONTEST_STATUS=$(grep '"contest_status"\s*:\s*"[^"][^"]*"' "$STATUS_JSON" | sed -e 's/",\s*$//' -e 's/^.*"//')
|
||||
status="$?"
|
||||
if [[ $status -ne 0 || -z $CONTEST_STATUS ]]; then
|
||||
echo "$0: ERROR: cannot determine contest_status from status.json: $STATUS_JSON" 1>&2
|
||||
exit 1
|
||||
fi
|
||||
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 status.json file
|
||||
#
|
||||
TMP_STATUS_JSON=".$NAME.$$.entry.md"
|
||||
if [[ $V_FLAG -ge 3 ]]; then
|
||||
echo "$0: debug[3]: temporary status.json file: $TMP_STATUS_JSON" 1>&2
|
||||
fi
|
||||
if [[ -z $NOOP ]]; then
|
||||
trap 'rm -f $TMP_STATUS_JSON; exit' 0 1 2 3 15
|
||||
rm -f "$TMP_STATUS_JSON"
|
||||
if [[ -e $TMP_STATUS_JSON ]]; then
|
||||
echo "$0: ERROR: cannot remove temporary status.json file: $TMP_STATUS_JSON" 1>&2
|
||||
exit 10
|
||||
fi
|
||||
:> "$TMP_STATUS_JSON"
|
||||
if [[ ! -e $TMP_STATUS_JSON ]]; then
|
||||
echo "$0: ERROR: cannot create temporary status.json file: $TMP_STATUS_JSON" 1>&2
|
||||
exit 11
|
||||
fi
|
||||
elif [[ $V_FLAG -ge 3 ]]; then
|
||||
echo "$0: debug[3]: because of -n, temporary status.json file is not used: $TMP_STATUS_JSON" 1>&2
|
||||
fi
|
||||
|
||||
# generate the temporary status.json file
|
||||
#
|
||||
# In this stage, we use the date of the actual status.json file.
|
||||
#
|
||||
if [[ -z $NOOP ]]; then
|
||||
|
||||
# generate a temporary status.json file based on current status, news.html and status.json
|
||||
#
|
||||
output_status_json "$CONTEST_STATUS" "$NEWS_HTML" "$STATUS_JSON" > "$TMP_STATUS_JSON"
|
||||
status="$?"
|
||||
if [[ $status -ne 0 ]]; then
|
||||
echo "$0: ERROR: failed to form temporary status.json file: $TMP_STATUS_JSON, error code: $status" 1>&2
|
||||
exit 12
|
||||
fi
|
||||
if [[ ! -s $TMP_STATUS_JSON ]]; then
|
||||
echo "$0: ERROR: failed to form temporary status.json, file missing or empty: $TMP_STATUS_JSON" 1>&2
|
||||
exit 13
|
||||
fi
|
||||
|
||||
# check if temporary status.json file is different from the actual status.json file
|
||||
#
|
||||
if cmp -s "$STATUS_JSON" "$TMP_STATUS_JSON"; then
|
||||
|
||||
# case: temporary status.json file is the same, nothing to do
|
||||
#
|
||||
if [[ $V_FLAG -ge 3 ]]; then
|
||||
echo "$0: debug[3]: no change to status.json" 1>&2
|
||||
fi
|
||||
|
||||
# case: temporary status.json file is different from the actual status.json
|
||||
#
|
||||
else
|
||||
|
||||
# case: temporary status.json file needs to replace status.json
|
||||
#
|
||||
# We now must rebuild the temporary status.json file using the new modification time,
|
||||
# so we now touch the status.json file for a new modification time.
|
||||
touch -m "$STATUS_JSON"
|
||||
status="$?"
|
||||
if [[ $status -ne 0 ]]; then
|
||||
echo "$0: ERROR: failed to touch -m $STATUS_JSON, error code: $status" 1>&2
|
||||
exit 14
|
||||
fi
|
||||
#
|
||||
# Rebuild temporary status.json file with updated (touched) modification time
|
||||
#
|
||||
output_status_json "$CONTEST_STATUS" "$NEWS_HTML" "$STATUS_JSON" > "$TMP_STATUS_JSON"
|
||||
status="$?"
|
||||
if [[ $status -ne 0 ]]; then
|
||||
echo "$0: ERROR: failed to reform temporary status.json file: $TMP_STATUS_JSON, error code: $status" 1>&2
|
||||
exit 15
|
||||
fi
|
||||
if [[ ! -s $TMP_STATUS_JSON ]]; then
|
||||
echo "$0: ERROR: failed to reform temporary status.json, file missing or empty: $TMP_STATUS_JSON" 1>&2
|
||||
exit 16
|
||||
fi
|
||||
#
|
||||
# touch the temporary status.json file to have the updated (touched) modification time
|
||||
#
|
||||
touch -m -r "$STATUS_JSON" "$TMP_STATUS_JSON"
|
||||
status="$?"
|
||||
if [[ $status -ne 0 ]]; then
|
||||
echo "$0: ERROR: failed to touch -m -r $STATUS_JSON $TMP_STATUS_JSON, error code: $status" 1>&2
|
||||
exit 17
|
||||
fi
|
||||
|
||||
# move the temporary status.json file into place
|
||||
#
|
||||
if [[ $V_FLAG -ge 1 ]]; then
|
||||
echo "$0: debug[1]: updating: $STATUS_JSON" 1>&2
|
||||
mv -v -f "$TMP_STATUS_JSON" "$STATUS_JSON"
|
||||
status="$?"
|
||||
if [[ $status -ne 0 ]]; then
|
||||
echo "$0: ERROR: failed to mv -v -f $TMP_STATUS_JSON $STATUS_JSON, error code: $status" 1>&2
|
||||
exit 18
|
||||
fi
|
||||
else
|
||||
mv -f "$TMP_STATUS_JSON" "$STATUS_JSON"
|
||||
status="$?"
|
||||
if [[ $status -ne 0 ]]; then
|
||||
echo "$0: ERROR: failed to mv -f $TMP_STATUS_JSON $STATUS_JSON, error code: $status" 1>&2
|
||||
exit 19
|
||||
fi
|
||||
fi
|
||||
fi
|
||||
|
||||
elif [[ $V_FLAG -ge 3 ]]; then
|
||||
echo "$0: debug[3]: because of -n, temporary status.json file is NOT written into: $TMP_STATUS_JSON" 1>&2
|
||||
fi
|
||||
|
||||
# use the md2html.sh tool to form the status.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[*]} --" \
|
||||
"status.md $STATUS_HTML" 1>&2
|
||||
fi
|
||||
"$MD2HTML_SH" "${TOOL_OPTION[@]}" -- \
|
||||
status.md "$STATUS_HTML"
|
||||
status="$?"
|
||||
if [[ $status -ne 0 ]]; then
|
||||
echo "$0: Warning: md2html.sh: $MD2HTML_SH ${TOOL_OPTION[*]} --" \
|
||||
"status.md $STATUS_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: $STATUS_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[*]} --" \
|
||||
"status.md $STATUS_HTML" 1>&2
|
||||
fi
|
||||
|
||||
# file cleanup
|
||||
#
|
||||
if [[ -z $NOOP ]]; then
|
||||
rm -f -- "$TMP_STATUS_JSON"
|
||||
elif [[ $V_FLAG -ge 3 ]]; then
|
||||
echo "$0: debug[3]: because of -n, disabled: rm -f -- $TMP_STATUS_JSON" 1>&2
|
||||
fi
|
||||
|
||||
# All Done!!! -- Jessica Noll, Age 2
|
||||
#
|
||||
exit 0
|
||||
+45
-35
@@ -73,6 +73,7 @@
|
||||
<hr>
|
||||
<div class="sidenav">
|
||||
<a href="../news.html">IOCCC News</a>
|
||||
<a href="../status.html">Contest status</a>
|
||||
<a href="../faq.html#submit">How to enter the IOCCC</a>
|
||||
<a href="../faq.html">FAQ</a>
|
||||
</div>
|
||||
@@ -165,13 +166,23 @@ index.html HTML files.</p>
|
||||
<p>Usage:</p>
|
||||
<div class="sourceCode" id="cb10"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb10-1"><a href="#cb10-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bin/gen-sitemap.sh</span> <span class="at">-v</span> 1</span></code></pre></div>
|
||||
<h3 id="gen-status.sh"><a href="gen-status.sh">gen-status.sh</a></h3>
|
||||
<p>Generate <code>status.json</code> according to the modification dates
|
||||
of <code>status.json</code> and <code>news.html</code>.</p>
|
||||
<p>Without argument, the <em>contest_status</em> is unchanged.</p>
|
||||
<p>Usage:</p>
|
||||
<div class="sourceCode" id="cb11"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb11-1"><a href="#cb11-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bin/gen-status.sh</span> <span class="at">-v</span> 1</span></code></pre></div>
|
||||
<p>To force the <em>contest_status</em> to be closed:</p>
|
||||
<div class="sourceCode" id="cb12"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb12-1"><a href="#cb12-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bin/gen-status.sh</span> <span class="at">-v</span> 1 closed</span></code></pre></div>
|
||||
<h3 id="gen-top-html.sh"><a
|
||||
href="gen-top-html.sh">gen-top-html.sh</a></h3>
|
||||
<p>Generate a number of top level HTML pages for the IOCCC web
|
||||
sites.</p>
|
||||
<p>Usage:</p>
|
||||
<div class="sourceCode" id="cb11"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb11-1"><a href="#cb11-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bin/gen-top-html.sh</span> <span class="at">-v</span> 1</span></code></pre></div>
|
||||
<div class="sourceCode" id="cb13"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb13-1"><a href="#cb13-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bin/gen-top-html.sh</span> <span class="at">-v</span> 1</span></code></pre></div>
|
||||
<p>Examples of top level HTML pages built by this tool include:</p>
|
||||
<ul>
|
||||
<li><a href="../CODE_OF_CONDUCT.html">CODE_OF_CONDUCT.html</a></li>
|
||||
@@ -192,18 +203,13 @@ href="../archive/historic/index.html">archive/historic/index.html</a></li>
|
||||
href="gen-year-index.sh">gen-year-index.sh</a></h3>
|
||||
<p>Generate an <code>index.html</code> page for an given IOCCC year.</p>
|
||||
<p>Usage:</p>
|
||||
<div class="sourceCode" id="cb12"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb12-1"><a href="#cb12-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bin/gen-year-index.sh</span> <span class="at">-v</span> 1 2020</span></code></pre></div>
|
||||
<div class="sourceCode" id="cb14"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb14-1"><a href="#cb14-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bin/gen-year-index.sh</span> <span class="at">-v</span> 1 2020</span></code></pre></div>
|
||||
<h3 id="gen-years.sh"><a href="gen-years.sh">gen-years.sh</a></h3>
|
||||
<p>Generate the top level <code>/years.html</code> page.</p>
|
||||
<p>Usage:</p>
|
||||
<div class="sourceCode" id="cb13"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb13-1"><a href="#cb13-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bin/gen-years.sh</span> <span class="at">-v</span> 1</span></code></pre></div>
|
||||
<h3 id="ioccc-status.sh"><a href="ioccc-status">ioccc-status.sh</a></h3>
|
||||
<p>Updates the <a href="../status.json">status.json</a> file.</p>
|
||||
<h3 id="manifest.entry.json.awk"><a
|
||||
href="manifest.entry.json.awk">manifest.entry.json.awk</a></h3>
|
||||
<p>Output manifest table from a entry .entry.json file.</p>
|
||||
<div class="sourceCode" id="cb15"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb15-1"><a href="#cb15-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bin/gen-years.sh</span> <span class="at">-v</span> 1</span></code></pre></div>
|
||||
<h3 id="md2html.sh"><a href="md2html.sh">md2html.sh</a></h3>
|
||||
<p>This is the primary tool that forms IOCCC generated HTML content from
|
||||
markdown files (permanent markdown files or temporarily generated
|
||||
@@ -239,17 +245,21 @@ up.</p>
|
||||
<p>If only a few <code>index.hmtl</code> files need updating, then this
|
||||
command will only briefly pause while the slightly longer <a
|
||||
href="readme2index.sh">readme2index.sh</a> is run:</p>
|
||||
<div class="sourceCode" id="cb14"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb14-1"><a href="#cb14-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bin/all-run.sh</span> <span class="at">-v</span> 3 bin/quick-readme2index.sh <span class="at">-v</span> 1</span></code></pre></div>
|
||||
<div class="sourceCode" id="cb16"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb16-1"><a href="#cb16-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bin/all-run.sh</span> <span class="at">-v</span> 3 bin/quick-readme2index.sh <span class="at">-v</span> 1</span></code></pre></div>
|
||||
<p><strong>NOTE</strong>: This command assumes that the relative
|
||||
modification times for <code>index.hmtl</code>,
|
||||
.entry.json<code>, and</code>index.html` are correct. If in doubt,
|
||||
use:</p>
|
||||
<div class="sourceCode" id="cb15"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb15-1"><a href="#cb15-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bin/all-run.sh</span> <span class="at">-v</span> 3 bin/readme2index.sh <span class="at">-v</span> 1</span></code></pre></div>
|
||||
<div class="sourceCode" id="cb17"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb17-1"><a href="#cb17-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bin/all-run.sh</span> <span class="at">-v</span> 3 bin/readme2index.sh <span class="at">-v</span> 1</span></code></pre></div>
|
||||
<h3 id="readme2index.sh"><a
|
||||
href="readme2index.sh">readme2index.sh</a></h3>
|
||||
<p>Convert a entry index.html into entry directory index.html.</p>
|
||||
<h3 id="status2html.sh"><a href="status2html.sh">status2html.sh</a></h3>
|
||||
<p>Convert <code>status.json</code> into HTML.</p>
|
||||
<p>This tool is a ‘before tool’ (-b tool) that is intended to be used by
|
||||
<code>bin/gen-status.sh</code>.</p>
|
||||
<h3 id="sgi.sh"><a href="sgi.sh">sgi.sh</a></h3>
|
||||
<p>Sort .gitignore content from stdin to stdout.</p>
|
||||
<p>We sort with lines starting with # first. We sort with lines starting
|
||||
@@ -261,11 +271,11 @@ href="sort.gitignore.sh">sort.gitignore.sh</a>.</p>
|
||||
href="sort.gitignore.sh">sort.gitignore.sh</a></h3>
|
||||
<p>Sort a .gitignore in a entry directory.</p>
|
||||
<p>Usage:</p>
|
||||
<div class="sourceCode" id="cb16"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb16-1"><a href="#cb16-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bin/sort.gitignore.sh</span> <span class="at">-v</span> 1 YYYY/dir</span></code></pre></div>
|
||||
<div class="sourceCode" id="cb18"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb18-1"><a href="#cb18-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bin/sort.gitignore.sh</span> <span class="at">-v</span> 1 YYYY/dir</span></code></pre></div>
|
||||
<p>Suggested usage:</p>
|
||||
<div class="sourceCode" id="cb17"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb17-1"><a href="#cb17-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bin/all-run.sh</span> bin/sort.gitignore.sh <span class="at">-v</span> 1</span></code></pre></div>
|
||||
<div class="sourceCode" id="cb19"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb19-1"><a href="#cb19-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bin/all-run.sh</span> bin/sort.gitignore.sh <span class="at">-v</span> 1</span></code></pre></div>
|
||||
<h3 id="subst.default.sh"><a
|
||||
href="subst.default.sh">subst.default.sh</a></h3>
|
||||
<p>Print default substitutions.</p>
|
||||
@@ -285,25 +295,25 @@ index.html.</p>
|
||||
<h2 id="tar-entry.sh"><a href="tar-entry.sh">tar-entry.sh</a></h2>
|
||||
<p>Form a compress tarball for an entry.</p>
|
||||
<p>Usage:</p>
|
||||
<div class="sourceCode" id="cb18"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb18-1"><a href="#cb18-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bin/tar-entry.sh</span> <span class="at">-v</span> 1 YYYY/dir</span></code></pre></div>
|
||||
<div class="sourceCode" id="cb20"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb20-1"><a href="#cb20-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bin/tar-entry.sh</span> <span class="at">-v</span> 1 YYYY/dir</span></code></pre></div>
|
||||
<p>Suggested usage:</p>
|
||||
<div class="sourceCode" id="cb19"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb19-1"><a href="#cb19-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bin/all-run.sh</span> <span class="at">-v</span> 3 bin/tar-entry.sh <span class="at">-v</span> 1 <span class="at">-W</span></span></code></pre></div>
|
||||
<div class="sourceCode" id="cb21"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb21-1"><a href="#cb21-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bin/all-run.sh</span> <span class="at">-v</span> 3 bin/tar-entry.sh <span class="at">-v</span> 1 <span class="at">-W</span></span></code></pre></div>
|
||||
<h2 id="tar-all.sh"><a href="tar-all.sh">tar-all.sh</a></h2>
|
||||
<p>Form the compressed tarball for all IOCCC years and all IOCCC
|
||||
entries.</p>
|
||||
<p>Usage:</p>
|
||||
<div class="sourceCode" id="cb20"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb20-1"><a href="#cb20-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bin/tar-all.sh</span> <span class="at">-v</span> 1</span></code></pre></div>
|
||||
<div class="sourceCode" id="cb22"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb22-1"><a href="#cb22-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bin/tar-all.sh</span> <span class="at">-v</span> 1</span></code></pre></div>
|
||||
<h2 id="tar-year.sh"><a href="tar-year.sh">tar-year.sh</a></h2>
|
||||
<p>Form a compress tarball for an IOCCC year.</p>
|
||||
<p>Usage:</p>
|
||||
<div class="sourceCode" id="cb21"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb21-1"><a href="#cb21-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bin/tar-year.sh</span> <span class="at">-v</span> 1 YYYY</span></code></pre></div>
|
||||
<div class="sourceCode" id="cb23"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb23-1"><a href="#cb23-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bin/tar-year.sh</span> <span class="at">-v</span> 1 YYYY</span></code></pre></div>
|
||||
<p>Suggested usage:</p>
|
||||
<div class="sourceCode" id="cb22"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb22-1"><a href="#cb22-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bin/all-years.sh</span> <span class="at">-v</span> 3 bin/tar-year.sh <span class="at">-v</span> 1 <span class="at">-W</span></span></code></pre></div>
|
||||
<div class="sourceCode" id="cb24"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb24-1"><a href="#cb24-1" aria-hidden="true" tabindex="-1"></a><span class="ex">bin/all-years.sh</span> <span class="at">-v</span> 3 bin/tar-year.sh <span class="at">-v</span> 1 <span class="at">-W</span></span></code></pre></div>
|
||||
<h1 id="how-ioccc-html-content-is-built"><a name="how"></a>How IOCCC
|
||||
HTML content is built</h1>
|
||||
<p>The <a href="md2html.sh">md2html.sh</a> tool is the primary tool that
|
||||
@@ -324,20 +334,20 @@ HTML content is built uses, by default, files from the <a
|
||||
href="../inc/index.html">inc</a> directory, of the form:</p>
|
||||
<pre><code>*.default.html</code></pre>
|
||||
<p>By using command line options of the form</p>
|
||||
<div class="sourceCode" id="cb24"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb24-1"><a href="#cb24-1" aria-hidden="true" tabindex="-1"></a><span class="ex">-H</span> phase=name</span></code></pre></div>
|
||||
<div class="sourceCode" id="cb26"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb26-1"><a href="#cb26-1" aria-hidden="true" tabindex="-1"></a><span class="ex">-H</span> phase=name</span></code></pre></div>
|
||||
<p>where <code>phase</code> is the name of an HTML phase, a non-default
|
||||
file may be used. For example:</p>
|
||||
<div class="sourceCode" id="cb25"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb25-1"><a href="#cb25-1" aria-hidden="true" tabindex="-1"></a><span class="ex">-H</span> topnav=up2index</span></code></pre></div>
|
||||
<div class="sourceCode" id="cb27"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb27-1"><a href="#cb27-1" aria-hidden="true" tabindex="-1"></a><span class="ex">-H</span> topnav=up2index</span></code></pre></div>
|
||||
<p>will cause <a
|
||||
href="../inc/topnav.up2index.html">inc/topnav.up2index.html</a> instead
|
||||
of <a href="../inc/topnav.default.html">inc/topnav.default.html</a> to
|
||||
be used during the <em>topnav</em> HTML phase.</p>
|
||||
<p>If <em>name</em> is dot (i.e., “.”), then the given HTML phase is
|
||||
skipped. For example:</p>
|
||||
<div class="sourceCode" id="cb26"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb26-1"><a href="#cb26-1" aria-hidden="true" tabindex="-1"></a><span class="ex">-H</span> footer=.</span></code></pre></div>
|
||||
<div class="sourceCode" id="cb28"><pre
|
||||
class="sourceCode sh"><code class="sourceCode bash"><span id="cb28-1"><a href="#cb28-1" aria-hidden="true" tabindex="-1"></a><span class="ex">-H</span> footer=.</span></code></pre></div>
|
||||
<p>will cause no HTML content to be produced during the <em>footer</em>
|
||||
HTML phase.</p>
|
||||
<h2 id="html-phases"><a name="html"></a>HTML phases</h2>
|
||||
|
||||
@@ -1,245 +0,0 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# ioccc_status.sh - quickly update status.json file
|
||||
#
|
||||
# Written by Cody Boone Ferguson in 2023:
|
||||
#
|
||||
# @xexyl
|
||||
# https://xexyl.net Cody Boone Ferguson
|
||||
# https://ioccc.xexyl.net
|
||||
#
|
||||
# If -s option is used, the status field is updated, providing that the status
|
||||
# arg is either "closed" or "open".
|
||||
#
|
||||
# If the -d or -n flags are used then it will update the status_date or
|
||||
# latest_news fields, respectively.
|
||||
#
|
||||
# If the -i status_ver option is used the IOCCC_status_version field will be
|
||||
# updated.
|
||||
#
|
||||
# The -N option is a dry-run: it will just show what would have been changed
|
||||
# without the option.
|
||||
#
|
||||
# The -S option lets one set the path to sed(1).
|
||||
#
|
||||
# The -G option lets one set the path to grep(1).
|
||||
#
|
||||
export IOCCC_STATUS_SCRIPT_VERSION="0.0.5-0 2024-01-22" # major.minor.release-patch YYYY-MM-DD
|
||||
|
||||
SED="$(type -P sed)"
|
||||
GREP="$(type -P grep)"
|
||||
|
||||
USAGE="usage: $(basename "$0") [-h] [-V] [-v level] [-s status] [-d] [-n] [-i status_ver] [-N] [-S] [-G] status.json
|
||||
|
||||
-h print help and exit
|
||||
-V print version and exit
|
||||
-v level set verbosity level
|
||||
-s status set contest status to open or closed
|
||||
|
||||
NOTE: status must be one of \"open\" or \"closed\"
|
||||
|
||||
-d update status_date
|
||||
-n update latest_news date
|
||||
-i status_ver update IOCCC_status_version
|
||||
|
||||
NOTE: version must match the regexp: ^[0-9]+\.[0-9]+ [0-9]{4}-[0-9]{2}-[0-9]{2}$
|
||||
|
||||
-N set dry-run mode: just show what would be changed (def: make changes)
|
||||
-S sed set path to sed(1) (def: $SED)
|
||||
-G grep set path to grep(1) (def: $GREP)
|
||||
|
||||
status.json the file to update
|
||||
|
||||
status version: $IOCCC_STATUS_SCRIPT_VERSION"
|
||||
|
||||
export UPDATE_DATE=""
|
||||
export UPDATE_NEWS=""
|
||||
export UPDATE_IOCCC_STATUS_VERSION=""
|
||||
export IOCCC_STATUS_VERSION=""
|
||||
export VERBOSITY=0
|
||||
export STATUS_JSON_FILE=""
|
||||
export STATUS_FLAG=""
|
||||
export STATUS="closed" # default closed
|
||||
export DRY_RUN_MODE=""
|
||||
export SED # already found default
|
||||
export GREP # already found default
|
||||
|
||||
# parse args
|
||||
#
|
||||
while getopts :hVv:s:dni:NS:G: flag; do
|
||||
case "$flag" in
|
||||
h) echo "$USAGE" 1>&2
|
||||
exit 2
|
||||
;;
|
||||
V) echo "$IOCCC_STATUS_SCRIPT_VERSION" 1>&2
|
||||
exit 2
|
||||
;;
|
||||
v) VERBOSITY="$OPTARG";
|
||||
;;
|
||||
s) STATUS_FLAG="-s"
|
||||
STATUS="$OPTARG";
|
||||
;;
|
||||
d) UPDATE_DATE="-d"
|
||||
;;
|
||||
n) UPDATE_NEWS="-n"
|
||||
;;
|
||||
i) UPDATE_IOCCC_STATUS_VERSION="-i"
|
||||
IOCCC_STATUS_VERSION="$OPTARG"
|
||||
;;
|
||||
N) DRY_RUN_MODE="-N"
|
||||
;;
|
||||
S) SED="$OPTARG"
|
||||
;;
|
||||
G) GREP="$OPTARG"
|
||||
;;
|
||||
:) echo "$0: ERROR: option -$OPTARG requires an argument" 1>&2
|
||||
echo 1>&2
|
||||
echo "$USAGE" 1>&2
|
||||
exit 3
|
||||
;;
|
||||
*)
|
||||
;;
|
||||
esac
|
||||
done
|
||||
|
||||
|
||||
# remove the options
|
||||
#
|
||||
shift $(( OPTIND - 1 ));
|
||||
|
||||
# verify arg count
|
||||
#
|
||||
if [[ $# != 1 ]]; then
|
||||
echo "$0: ERROR: expected exactly one arg, got: $#" 1>&2
|
||||
echo 1>&2
|
||||
echo "$USAGE" 1>&2
|
||||
exit 3
|
||||
fi
|
||||
|
||||
# parse args
|
||||
#
|
||||
if [[ $# -gt 0 ]]; then
|
||||
export STATUS_JSON_FILE="$1"
|
||||
fi
|
||||
|
||||
# firewall STATUS_JSON_FILE must be a readable file
|
||||
#
|
||||
if [[ ! -e $STATUS_JSON_FILE ]]; then
|
||||
echo "$0: ERROR: status.json does not exist: $STATUS_JSON_FILE" 1>&2
|
||||
exit 1
|
||||
fi
|
||||
if [[ ! -f $STATUS_JSON_FILE ]]; then
|
||||
echo "$0: ERROR: status.json not a regular file: $STATUS_JSON_FILE" 1>&2
|
||||
exit 1
|
||||
fi
|
||||
if [[ ! -r $STATUS_JSON_FILE ]]; then
|
||||
echo "$0: ERROR: status.json not a readable file: $STATUS_JSON_FILE" 1>&2
|
||||
exit 1
|
||||
fi
|
||||
if [[ ! -w $STATUS_JSON_FILE ]]; then
|
||||
echo "$0: ERROR: status.json is not a writable file: $STATUS_JSON_FILE" 1>&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# check that $SED is an executable file
|
||||
if [[ ! -x "$SED" ]]; then
|
||||
echo "$0: sed not an executable file: $SED" 1>&2
|
||||
exit 3
|
||||
fi
|
||||
# check that $GREP is an executable file
|
||||
if [[ ! -x "$GREP" ]]; then
|
||||
echo "$0: grep not an executable file: $GREP" 1>&2
|
||||
exit 3
|
||||
fi
|
||||
|
||||
# check that if -s ($STATUS_FLAG) used that the status ($STATUS) is either 'open' or 'closed'
|
||||
#
|
||||
if [[ -n "$STATUS_FLAG" ]]; then
|
||||
if [[ "$STATUS" != "open" && "$STATUS" != "closed" ]]; then
|
||||
echo "$0: ERROR: status must be 'open' or 'closed'" 1>&2
|
||||
exit 3
|
||||
fi
|
||||
fi
|
||||
|
||||
# check format of IOCCC_status_version if set (-i used, $UPDATE_IOCCC_STATUS_VERSION)
|
||||
#
|
||||
if [[ -n "$UPDATE_IOCCC_STATUS_VERSION" ]]; then
|
||||
echo "$IOCCC_STATUS_VERSION" | "$GREP" -qE '^[0-9]+\.[0-9]+ [0-9]{4}-[0-9]{2}-[0-9]{2}$'
|
||||
if [[ "${PIPESTATUS[1]}" -ne 0 ]]; then
|
||||
echo "$0: ERROR: IOCCC_status_version must match the regexp: '^[0-9]+\.[0-9]+ [0-9]{4}-[0-9]{2}-[0-9]{2}$'" 1>&2
|
||||
exit 3
|
||||
fi
|
||||
fi
|
||||
|
||||
# get date for options that update the date
|
||||
DATE="$(date)"
|
||||
# if verbosity is >= 1 or dry-run specified show what would/will be updated
|
||||
if [[ "$VERBOSITY" -ge 1 ]]; then
|
||||
echo "$0: status.json file: $STATUS_JSON_FILE" 1>&2
|
||||
if [[ -n "$STATUS_FLAG" ]]; then
|
||||
echo "$0: will update contest status to: \"$STATUS\"" 1>&2
|
||||
fi
|
||||
if [[ -n "$UPDATE_DATE" ]]; then
|
||||
echo "$0: will update status_date to: \"$DATE\"" 1>&2
|
||||
fi
|
||||
if [[ -n "$UPDATE_NEWS" ]]; then
|
||||
echo "$0: will update latest_news to: \"$DATE\"" 1>&2
|
||||
fi
|
||||
if [[ -n "$UPDATE_IOCCC_STATUS_VERSION" ]]; then
|
||||
echo "$0: will update IOCCC_status_version to: \"$IOCCC_STATUS_VERSION\"" 1>&2
|
||||
fi
|
||||
elif [[ -n "$DRY_RUN_MODE" ]]; then
|
||||
echo "$0: status.json file: $STATUS_JSON_FILE" 1>&2
|
||||
if [[ -n "$STATUS_FLAG" ]]; then
|
||||
echo "$0: would update contest status to: \"$STATUS\"" 1>&2
|
||||
fi
|
||||
if [[ -n "$UPDATE_DATE" ]]; then
|
||||
echo "$0: would update status_date to: \"$DATE\"" 1>&2
|
||||
fi
|
||||
if [[ -n "$UPDATE_NEWS" ]]; then
|
||||
echo "$0: would update latest_news to: \"$DATE\"" 1>&2
|
||||
fi
|
||||
if [[ -n "$UPDATE_IOCCC_STATUS_VERSION" ]]; then
|
||||
echo "$0: would update IOCCC_status_version to: \"$IOCCC_STATUS_VERSION\"" 1>&2
|
||||
fi
|
||||
|
||||
# nothing to do, exit success
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# first status_date if requested and not dry-run
|
||||
if [[ -n "$UPDATE_DATE" ]]; then
|
||||
"$SED" -i'' "s|\"status_date\" : \".*[^\"]\"|\"status_date\" : \"$DATE\"|g" "$STATUS_JSON_FILE"
|
||||
|
||||
if [[ "$VERBOSITY" -gt 1 ]]; then
|
||||
echo "$0: updated status_date to: \"$DATE\"" 1>&2
|
||||
fi
|
||||
fi
|
||||
|
||||
# then update latest_news date if requested
|
||||
if [[ -n "$UPDATE_NEWS" ]]; then
|
||||
"$SED" -i'' "s|\"latest_news\" : \".*[^\"]\"|\"latest_news\" : \"$DATE\"|g" "$STATUS_JSON_FILE"
|
||||
|
||||
if [[ "$VERBOSITY" -gt 1 ]]; then
|
||||
echo "$0: updated latest_news to: \"$DATE\"" 1>&2
|
||||
fi
|
||||
fi
|
||||
|
||||
# then update IOCCC_STATUS_VERSION if requested
|
||||
if [[ -n "$UPDATE_IOCCC_STATUS_VERSION" ]]; then
|
||||
"$SED" -i'' "s|\"IOCCC_status_version\" : \".*[^\"]\"|\"IOCCC_status_version\" : \"$IOCCC_STATUS_VERSION\"|g" "$STATUS_JSON_FILE"
|
||||
|
||||
if [[ "$VERBOSITY" -gt 1 ]]; then
|
||||
echo "$0: updated IOCCC_status_version to: \"$IOCCC_STATUS_VERSION\"" 1>&2
|
||||
fi
|
||||
fi
|
||||
|
||||
# finally if we need to change the status of the contest do so
|
||||
if [[ -n "$STATUS_FLAG" ]]; then
|
||||
"$SED" -i'' "s|\"contest\" : \".*[^\"]\"|\"contest\" : \"$STATUS\"|g" "$STATUS_JSON_FILE"
|
||||
|
||||
if [[ "$VERBOSITY" -gt 1 ]]; then
|
||||
echo "$0: updated contest status to: \"$STATUS\"" 1>&2
|
||||
fi
|
||||
fi
|
||||
exit 0
|
||||
Executable
+382
@@ -0,0 +1,382 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# status2html.sh - output status.json HTML for the status.html page
|
||||
#
|
||||
# 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 "bin/gen-status.sh"
|
||||
#
|
||||
# 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 - must be bash with a version 4.2 or later
|
||||
#
|
||||
# We must declare arrays with -ag or -Ag, and we need loops to "export" modified variables.
|
||||
#
|
||||
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 . or ..
|
||||
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 2024-03-09"
|
||||
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
|
||||
export DOCROOT_SLASH="./"
|
||||
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 URL="#"
|
||||
|
||||
# set usage message
|
||||
#
|
||||
export USAGE="usage: $0 [-h] [-v level] [-V] [-d topdir] [-D docroot/] [-n] [-N]
|
||||
[-p tool] [-u repo_url] [-U url] [-w site_url] [-e string ..] [-E exitcode]
|
||||
|
||||
-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)
|
||||
-D docroot/ set the document root path followed by slash (def: $DOCROOT_SLASH)
|
||||
NOTE: 'docroot' must end in a slash
|
||||
|
||||
-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)
|
||||
|
||||
-u repo_url Base level URL of target git repo (def: $REPO_URL)
|
||||
-U url URL of HTML file being formed (def: $URL)
|
||||
-w site_url Base URL of the web site (def: $SITE_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)
|
||||
|
||||
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 < 4.2
|
||||
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
|
||||
8 error in status.json file
|
||||
>= 10 internal error
|
||||
|
||||
$NAME version: $VERSION"
|
||||
|
||||
# setup
|
||||
#
|
||||
export NOOP=
|
||||
export DO_NOT_PROCESS=
|
||||
|
||||
# parse command line
|
||||
#
|
||||
while getopts :hv:Vd:D:nNp:u:U:w: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"
|
||||
;;
|
||||
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"
|
||||
;;
|
||||
n) NOOP="-n"
|
||||
;;
|
||||
N) DO_NOT_PROCESS="-N"
|
||||
;;
|
||||
p) PANDOC_WRAPPER="$OPTARG"
|
||||
;;
|
||||
u) REPO_URL="$OPTARG"
|
||||
;;
|
||||
U) URL="$OPTARG"
|
||||
;;
|
||||
w) SITE_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
|
||||
if [[ $V_FLAG -ge 5 ]]; then
|
||||
echo "$0: debug[5]: arg: $1" 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 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 pandoc wrapper tool
|
||||
#
|
||||
if [[ ! -e $PANDOC_WRAPPER ]]; then
|
||||
echo "$0: ERROR: pandoc wrapper tool does not exist: $PANDOC_WRAPPER" 1>&2
|
||||
exit 5
|
||||
fi
|
||||
if [[ ! -f $PANDOC_WRAPPER ]]; then
|
||||
echo "$0: ERROR: pandoc wrapper tool is not a file: $PANDOC_WRAPPER" 1>&2
|
||||
exit 5
|
||||
fi
|
||||
if [[ ! -x $PANDOC_WRAPPER ]]; then
|
||||
echo "$0: ERROR: pandoc wrapper tool is not an executable file: $PANDOC_WRAPPER" 1>&2
|
||||
exit 5
|
||||
fi
|
||||
|
||||
# verify status.json file
|
||||
#
|
||||
export STATUS_JSON="status.json"
|
||||
if [[ ! -e $STATUS_JSON ]]; then
|
||||
echo "$0: ERROR: status.json does not exist: $STATUS_JSON" 1>&2
|
||||
exit 1
|
||||
fi
|
||||
if [[ ! -f $STATUS_JSON ]]; then
|
||||
echo "$0: ERROR: status.json is not a regular file: $STATUS_JSON" 1>&2
|
||||
exit 1
|
||||
fi
|
||||
if [[ ! -r $STATUS_JSON ]]; then
|
||||
echo "$0: ERROR: status.json is not an readable file: $STATUS_JSON" 1>&2
|
||||
exit 1
|
||||
fi
|
||||
if [[ ! -s $STATUS_JSON ]]; then
|
||||
echo "$0: ERROR: status.json is not an non-empty readable file: $STATUS_JSON" 1>&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# parameter debugging
|
||||
#
|
||||
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]: DOCROOT_SLASH=$DOCROOT_SLASH" 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]: URL=$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]: REPO_NAME=$REPO_NAME" 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]: STATUS_JSON=$STATUS_JSON" 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
|
||||
|
||||
# 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 10
|
||||
fi
|
||||
:> "$TMP_FILE"
|
||||
if [[ ! -e $TMP_FILE ]]; then
|
||||
echo "$0: ERROR: cannot create temporary markdown file: $TMP_FILE" 1>&2
|
||||
exit 11
|
||||
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 temporary markdown file for status.json
|
||||
#
|
||||
{
|
||||
echo '# <a name="content"></a>status.json'
|
||||
echo '```json'
|
||||
cat "$STATUS_JSON"
|
||||
echo '```'
|
||||
} | if [[ -z $NOOP ]]; then
|
||||
cat >> "$TMP_FILE"
|
||||
else
|
||||
cat > /dev/null
|
||||
if [[ $V_FLAG -ge 3 ]]; then
|
||||
echo "$0: debug[3]: -n disabled write of author header into: $TMP_FILE" 1>&2
|
||||
fi
|
||||
fi
|
||||
|
||||
# convert temporary markdown file into HTML
|
||||
#
|
||||
if [[ -z $NOOP ]]; then
|
||||
echo "<!-- START: this line starts content generated by: bin/$NAME -->"
|
||||
echo
|
||||
if [[ $V_FLAG -ge 1 ]]; then
|
||||
echo "$0: debug[1]: about to execute: $PANDOC_WRAPPER $TMP_FILE -" 1>&2
|
||||
fi
|
||||
"$PANDOC_WRAPPER" "$TMP_FILE" -
|
||||
status="$?"
|
||||
if [[ $status -ne 0 ]]; then
|
||||
echo "$0: ERROR: pandoc failed, error: $status" 1>&2
|
||||
exit 1
|
||||
fi
|
||||
echo
|
||||
echo "<!-- END: next line ends content generated by: bin/$NAME -->"
|
||||
elif [[ $V_FLAG -ge 1 ]]; then
|
||||
echo "$0: debug[1]: -n disabled execution of: $PANDOC_WRAPPER $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
|
||||
Reference in new issue
Block a user