wxrx/generate_website.sh

#!/usr/bin/env sh
## Generates a "website" from decoded satellite data
## 
## Usage: __PROG__ [options] file
##
## Supply one or more manifest files
## A manifest file is a text file containing the paths to every file used in
## a decoding, including the .wav file and every .png.
##
## Each manifest file is used to generate a static web-page.
##
## Put this directory on your web server or sync to your online storage "bucket".
##
prog="$0"
me=${HELP:-`basename "$prog"`}
rootdir=$(dirname $(realpath $0))
source ${rootdir}/lib/utils.sh
source ${rootdir}/lib/website_generatorlib.sh

index_item_file="/tmp/wxrx-index"
rm -f ${index_item_file}

function render_pass_audio() {
  file=${1}
  path=$(publish_audio ${file})
  cat $(template_path pass-audio) |
    template_subst WAV_FILE "${path}"
}

function render_pass_image() {
  file=${1}
  path=$(publish_image ${file})
  caption=$(description_from_filename "${1}")
  cat $(template_path pass-image) |
    template_subst SRC "${path}" |
    template_subst ALT "Decoded satellite image" |
    template_subst CAPTION "${caption}"
}

function generate_manifest_thumbnail() {
  #TODO: generate an actual thumbnail and move it to the web dir
  # skip if file exists, unless forced
  cat $1 | grep -m1 '\.png'
}

#
# @param manifest file
# @global rebuild_all read
# @side effect creates an .html file
function generate_from_manifest() {
  manifest=${1}
  relative_path="$(basename "${manifest}" -manifest.txt).html"
  outfile="${WXRX_WEB_PUBDIR}/${relative_path}"
  timestamp=$(timestamp_from_filename $(basename ${relative_path}))

  title="Example Title"
  heading="Example heading"
  thumbnail=$(generate_manifest_thumbnail "${1}")
  # count this file as processed
  printf "%d\t%s\t%s\n" "${timestamp}" "${relative_path}" "${thumbnail}" >> ${index_item_file}


  if [ -f $outfile ] && [ "$outfile" -nt "${manifest}" ]; then
    if [ $rebuild_all -gt 0 ]; then
      log "--force option used; Re-generating %s" "${outfile}"
    else
      log "%s already exists and is newer than manifest file. Skipping" "${outfile}"
      return
    fi
  fi

  log "Generating page %s from %s" "$outfile" "${manifest}"
  article_content=""
  for file in $(cat ${manifest})
  do
    case $file in
      *.wav)
        log "\t...wavfile %s" "${file}"
        heading="$(timestamp_from_file ${file})"
        title="Satellite Pass - ${heading}"
        article_content="${article_content}$(render_pass_audio "$file")"
        ;;
      *.png)
        log "\t..image %s" "${file}"
        article_content="${article_content}$(render_pass_image "$file")"
        ;;
      *)
        logerr "Not sure what to do with this file: %s" "${file}"
        ;;
    esac
  done

  content=$(cat $(template_path pass) |
    template_subst TITLE "${heading}" |
    template_subst CONTENT "${article_content}")

  cat $(template_path document) |
    template_subst TITLE "${title}" |
    template_subst CONTENT "${content}" |
    template_subst GENERATED_AT "$(date '+%a %b %d %T %Z %Y')" |
    tidy -quiet -indent -o ${outfile}
  
}

function generate_index() {
  outfile="${WXRX_WEB_PUBDIR}/index.html"
  log "Generating index file: %s" "${outfile}"
  index_content=""
  IFS=$'\n'
  for line in $(tac $index_item_file); do
    timestamp=$(echo "${line}" | cut -f1)
    url=$(echo "${line}" | cut -f2)
    heading=$(date -d "@$(timestamp_from_filename "${url}")" '+%a %b %d %T %Z %Y')
    thumbnail=$(echo "${line}" | cut -f3)
    log "\t...generating item: %s" "${url}"
    index_content="${index_content} $(cat $(template_path item) |
      template_subst URL "${url}" |
      template_subst HEADING "${heading}" |
      template_subst THUMBNAIL "$(publish_image ${thumbnail})")"
  done
  unset IFS

  index_content=$(cat $(template_path index) |
    template_subst HEADING "${title}" |
    template_subst CONTENT "${index_content}")

  cat $(template_path document) |
    template_subst TITLE "${title}" |
    template_subst CONTENT "${index_content}" |
    template_subst GENERATED_AT "$(date '+%a %b %d %T %Z %Y')" |
    tidy -quiet -indent -o ${outfile}
}

function description_from_filename() {
  filename=${1}
  re="(noaa_1[589])-([0-9]+)-([a-Z\-]+)"
  if [[ $filename =~ $re ]]; then
    satname=$(echo "${BASH_REMATCH[1]}" | awk '{ gsub("_", "-"); print toupper($0) }')
    timestamp=$(date -d "@${BASH_REMATCH[2]}" '+%a %b %d %T %Z %Y')
    enhancement=${BASH_REMATCH[3]}
    echo "${satname} $enhancement recorded ${timestamp}"
  else
    echo $(basename ${filename} .png)
  fi
}

function timestamp_from_filename() {
  # TODO: print at most one line
  echo "${1}" | grep -oP -m1 '[0-9]{9,}'
}

function timestamp_from_file() {
  filename=${1}
  date -d "@$(stat -c '%Y' $filename)" '+%a %b %d %T %Z %Y'
}


index_data=()
rebuild_all=0
##  Options:
while (( "$#" ));
do

## --help, -h                   Help message
  case "${1}" in
    '--help' | '-h')
      usage
      exit
      ;;

## --force, -f                  Force rebuild of previously generated pages
    '--force' | '-f')
      rebuild_all=1
      ;;

    *)
      # if this is an unrecognized flag, log an error
      if [[ $1 == -* ]] ; then
        logerr "Unknown option %s.  If you meant to process the a file named '%s' use './%s'" ${1} ${1} ${1}
        usage
        exit 1
      fi
      generate_from_manifest ${1}
      ;;
  esac
  shift
done

# if (( ${#index_data[@]} == 0 )); then
#   logerr "No files processed.  Supply the path to one or more manifest files"
#   usage
#   exit 1
# fi

generate_index

exit # normal exit