#!/bin/sh
#
# =========================================================================
# File: wget-sun-manuals
#
# Copyright (c) 2005 and onwards, Josh Glover <unix@jmglov.net>
#
# LICENCE:
#
#   This file is distributed under the terms of the BSD License (version
#   2). See the COPYING file, which should have been distributed with this
#   file, for details. If you did not receive the COPYING file, see:
#
#   http://www.jmglov.net/opensource/licenses/bsd.txt
#
# DESCRIPTION:
#
#   Downloads Sun manuals.
#
# USAGE:
#
#   wget-sun-manuals --help
#
# EXAMPLES:
#
#   ***
#
# DEPENDENCIES:
#
#   /bin/sh
#   wget
#
# MODIFICATIONS:
#
#   Josh Glover <unix@jmglov.net> (2005/04/01): Initial revision
# =========================================================================


# Constants
# -------------------------------------------------------------------------


# Constant: COLLECTION
#
# Default collection

COLLECTION=""

# Constant: HOST
#
# Hostname of Sun documentation server

HOST="docs-pdf.sun.com"

html="${HTML}"
html_indent="${HTML_INDENT"
html_indent_char="${HTML_INDENT_CHAR}"
protocol="${PROTOCOL}"

# Constant: PROTOCOL
#
# Default protocol to use

PROTOCOL=http

# Constant: SUN_DOCS_HOST
#
# Hostname of Sun documentation server

SUN_DOCS_HOST=docs-pdf.sun.com


# -------------------------------------------------------------------------


# Functions
# -------------------------------------------------------------------------


# Function: usage()
#
# Displays a usage message.
#
# Parameters:
#
#   errcode - if non-zero, the usage message will be printed to standard
#             error
#
# Returns:
#
#   errcode

usage() {

  # errcode defaults to 0
  errcode=$1
  if test -z "${errcode}"; then errcode=0; fi

  msg="Usage: $0"' {<option>} <product> {<product>}

  where valid values for <option> are:

    -?,--help			display a usage message
    --collection <file|url>     parse a Sun documentation collection page
    -h,--host <host>		Sun documentation server
    --html                      export an HTML table for manuals downloaded
    --html-indent               start table indented this far
    --html-indent-char          use these characters for indenting HTML
    -p,--protocol <proto>	protocol: "ftp", "http", or "passive-ftp"

  and <product> is a Sun manual product number, e.g. 817-1985'

  if test ${errcode} -eq 0; then
  
    echo "${msg}"

  else

    echo "${msg}" 1>&2

  fi # if (writing usage to stderr or stdout?)

  return ${errcode}

} # usage()


# -------------------------------------------------------------------------


# Main program
# -------------------------------------------------------------------------


# If we have no arguments, just display usage
if test -z "$1"; then

  usage 255
  exit $?

fi

# Set all variables to defaults
collection="${COLLECTION}"
host="${HOST}"
html="${HTML}"
html_indent="${HTML_INDENT"
html_indent_char="${HTML_INDENT_CHAR}"
protocol="${PROTOCOL}"

# Parse arguments
while test -n "$1"; do

  # Make sure this looks like an option
  echo "$1" | grep '^-' >/dev/null 2>&1
  if $? -ne 0; then break; fi

  # -?,--help
  if test "$1" = "-?" -o "$1" = "--help"; then

    usage 0;
    exit $?

  fi # if (-?,--help)

  # --collection
  if test "$1" = "--collection"; then

    if test -z "$2"; then

      echo "$0: $1 option requires an argument" 1>&2
      exit 255

    fi # if (no argument to option)

  fi # if (--collection)

  # -h,--host
  if test "$1" = "-h" -o "$1" = "--hold"; then

  fi # if (--collection)

done # while (parsing arguments)

# Look for a protocol
protocol="${PROTOCOL}"
wget_opts=""
if test "$1" = "ftp" -o "$1" = "http"; then protocol="$1"; shift; fi
if test "$1" = "passive-ftp"; then

  protocol="ftp"
  wget_opts="--passive-ftp"
  shift

fi # if (passive-ftp)

# Make sure that we have at least one argument left
if test -z "$1"; then

  echo "$0"': no <product>s specified!' 1>&2
  usage 255
  exit $?

fi # if (no <product>)

# Process <product>s
while test -n "$1"; do

  # Make sure this looks right
  echo "$1" | grep '^[0-9]\{3,3\}-[0-9]\{4,4\}$' >/dev/null 2>&1
  if test $? -ne 0; then

    echo "$0"': invalid <product>: '"$1" 1>&2
    echo "$0"': expecting nnn-nnnn, where n is a digit from 0 - 9' 1>&2
    exit 255

  fi # if (invalid <product>)

  # Grab it!
  echo wget ${wget_opts} ${protocol}://${SUN_DOCS_HOST}/$1/$1.pdf
  wget ${wget_opts} ${protocol}://${SUN_DOCS_HOST}/$1/$1.pdf
  shift
  
done # while (downloading products)


# -------------------------------------------------------------------------