#!/bin/bash
#
# Build script for <PACKAGE>
#
# This build script is meant to be executed from within the source
# directory created by extracting the tarball.
#
# It will create up to 12 log files in the $HOME directory:
#
#   configure.log: All messages output during configure
#   configure.err: Just the errors output during configure
#        make.log: All messages output during make
#        make.err: Just the errors output during make
#       check.log: All messages output during make check/test
#       check.err: Just the errors output during make check/test
#     install.log: All messages output during make install
#     install.err: Just the errors output during make install
#         upd.log: Any messages from updating the package list
#                  (usually nothing)
#         upd.err: Just the errors from updating the package list
#                  (usually nothing)
#      verupd.log: Any messages from updating the package version
#                  (usually nothing)
#      verupd.err: Just the errors from updating the package version
#                  (usually nothing)
#
# After running the script you should check the *.err files to see
# if any problems have occurred. If that is the case, use the corresponding
# *.log files to see the error messages in context.
#
# Note: the ":" before the "}" in *_commands() is a no-op that makes sure 
# that the function remains syntactically valid, even if you remove its
# contents (e.g. remove the "configure" line, because there's nothing to 
# configure for the package).
#
# Comments throughout the script marked "#*" are places where you may
# have to change things for individual package circumstances.

## Version info.
ourname=${0##*/}
VERSION=1.0
COPYRIGHT="Copyright (C) 2007 - 2010 Steve Youngs <steve@steveyoungs.com>"
version_str="${ourname}: ${VERSION}\n${COPYRIGHT}"

show_version()
{
    echo -e $version_str
    exit 0
}

#*
# Set this to 1 (one) if the package's version can be updated
# automatically
auto_version=0

#*
# Set the configure commands/options here.  Remove everything except
# the braces and colon if the package has no configure.
configure_commands()
{ :
    ./configure --prefix=/usr \
        --infodir=/usr/share/info \
        --mandir=/usr/share/man \
        --sysconfdir=/etc \
        --libexecdir=/usr/lib \
        --localstatedir=/var
}

#*
# Set the make commands/options here.
make_commands()
{ :
    make
}

#*
# Set the test suite commands/options here.  Remove everything except
# the braces and colon if the package has no test suite
check_commands()
{ :
    make check
}

#*
# Set the install commands/options here.
install_commands()
{ :
    make install &&
    # libtool .la files DO NOT need to be executable! (remove if not a
    # libtool'd package)
    forall_direntries_from $(whoami) -name \*.la -exec chmod -v 644 {} \;
}

update_commands()
{ :
    sed -i s/"Last_Updated.*"/"Last_Updated: $(date +%c)"/g ${HOME}/.project
    awk '/^CONTENTS:/ { print; exit; } {print}' ${HOME}/.project > ${HOME}/.projtmp
    echo "--------" >> ${HOME}/.projtmp
    list_package $(whoami) >> ${HOME}/.projtmp
    mv ${HOME}/.projtmp ${HOME}/.project
}

#*
#  Set `arg' to command(s) that output just the version number of the
#  package.
version_commands()
{ :
    # Commands to update the version string in .project
    arg=''  # replace with something that returns a version number.
    sed -i "s|\(Version: \).*$|\1${arg}|" ${HOME}/.project
}

#======================================================================#
### There shouldn't be anything beyond this point to tweak or change ###
#======================================================================#
 
test_pipe()
{
    for i in "${PIPESTATUS[@]}"; do
        test $i != 0 && { echo FAILED! ; exit 1 ; }
    done
    echo successful!
    return 0
}


run_configure()
{
    echo -n "Configuring ($(whoami))... "
    { configure_commands 3>&1 1>&2 2>&3 | tee "$HOME/configure.err" ;} \
	&>"$HOME/configure.log"
    test_pipe
    [[ ${only} = yes ]] && exit 0 || run_build
}

run_build()
{
    echo -n "Building ($(whoami))... "
    { make_commands 3>&1 1>&2 2>&3 | tee "$HOME/make.err" ;} \
	&>"$HOME/make.log"
    test_pipe
    [[ ${only} = yes ]] && exit 0 || run_check
}

run_check()
{
    echo -n "Checking ($(whoami))... "
    { check_commands 3>&1 1>&2 2>&3 | tee "$HOME/check.err" ;} \
	&>"$HOME/check.log"
    test_pipe
    [[ ${only} = yes ]] && exit 0 || run_install
}

run_install()
{
    echo -n "Installing ($(whoami))... "
    { install_commands 3>&1 1>&2 2>&3 | tee "$HOME/install.err" ;} \
	&>"$HOME/install.log"
    test_pipe
    [[ ${only} = yes ]] && exit 0 || run_update
}

run_update()
{
    echo -n "Updating package list ($(whoami))... "
    { update_commands 3>&1 1>&2 2>&3 | tee "$HOME/upd.err" ;} \
	&>"$HOME/upd.log"
    test_pipe
    # maybe update the version too
    if [ $auto_version -eq 1 ];then
	echo -n "Updating package version ($(whoami))... "
	{ version_commands 3>&1 1>&2 2>&3 | tee "$HOME/verupd.err" ;} \
	    &>"$HOME/verupd.log"
	test_pipe
    fi
}

# Help
usage()
{
    # Look for a pager to display the help with.
    local _cat

    if [ ${PAGER} ]; then
	# User has PAGER env var set, use that.
	_cat=${PAGER}
    else
	# No PAGER var set, try most->less->more->cat
	for pager in most less more cat; do
	    if [ -x "$(which $pager)" ]; then
		_cat=$pager
		break
	    else
		continue
	    fi
	done
    fi

    $_cat<<EOF
                               $ourname
         ${VERSION}


Synopsis:
--------

  $ourname
  $ourname
        [ -c | -C | -b | -B | -k | -K | -i | -I | -u ]
	[ --conf | --conf_only | --build | --build_only | --check ]
	[ --check_only | --install | --install_only | --upd_list ]
  $ourname
        [ -h | --help ]
  $ourname
	[ -v | --version ]

Description:
-----------

  $ourname is a general purpose build script.  It should fit the bill
  for most packages out of the box.  However you should ALWAYS check
  through the script before running it blindly on a package.

  The places in the script that will require your attention each time
  you set up a new package have been marked with "#*".

Options:
-------

  Most times you will not need to specify any command line options.
  They exist mainly for those times when something has gone awry.

  -c
  --conf
        Run the script from the configure stage, onwards.  This is
        synonymous with running the script without any command line
        options.

  -C
  --conf_only
        Run just the configure stage and then exit.

  -b
  --build
        Run the script from the build (make) stage, onwards.  Specifying
        this option forces the script to skip the configure stage.  Do
        not use this option simply because the package does not have a
        configure, in that case, you are better off simply removing the
        contents of the "configure_commands" function.

  -B
  --build_only
        Run just the build (make) stage and then exit.

  -k
  --check
        Run the script from the check (testsuite) stage, onwards.
        Specifying this option forces the script to skip the configure
        and build stages.

  -K
  --check_only
        Run just the check (testsuite) stage and then exit.

  -i
  --install
        Run the script from the install stage, onwards.  Specifying
        this option forces the script to skip the configure, build,
        and check stages.

  -I
  --install_only
        Run just the install stage and then exit.

  -u
  --upd_list
        Updates the package file list kept in the .project file.  This
        option also updates the package version in that file too if
        possible.

  -h
  --help
        Display this usage info and exit.

  -v
  --version
        Display version and copyright info and exit.

Files:
-----

  ${HOME}/.project
        Has information about the package, including (but not limited
        to), website, repo location and type, version, date last
        updated, installation notes, and complete file list.

  ${HOME}/configure.log
        Contains all messages output during configure.

  ${HOME}/configure.err
        Contains only error messages output during configure.

  ${HOME}/make.log
        Contains all messages output during make.

  ${HOME}/make.err
        Contains only error messages output during make.

  ${HOME}/check.log
        Contains all messages output from running a package testsuite.

  ${HOME}/check.err
        Contains only error messages output from running a package
        testsuite.

  ${HOME}/install.log
        Contains all messages output during install.

  ${HOME}/install.err
        Contains only error messages output during install.

  ${HOME}/upd.log
        Contains all messages output during the update of the package
        file list.  This log is nearly always empty, or at least it
        should be.

  ${HOME}/upd.err
        Contains only error messages output during the update of the
        package file list.  This log is nearly always empty, or at
        least it should be.

  ${HOME}/updver.log
        Contains all messages output when updating the package version
        info.  It should be empty.

  ${HOME}/updver.err
        Contains only error messages output when updating the package
        version info.  It should be empty.

Exit Codes:
----------

  0 -- Successful completion.
  1 -- Something bad happened.
  2 -- Bad command line option.

$COPYRIGHT

EOF
}

# Command line parsing.
# Yes, it is possible to give more than one option on the command
# line, but that normally doesn't make much sense.  Consider:
# '../build --conf_only --install' the --conf_only option will
# cause the script to exit before the install happens.
args=cCbBkKiIuhV-:
only=no

if [ $1 ]; then
    # We have cmdline args, deal with them.
    while getopts $args opts; do
	case $opts in
	    (-)
                case $OPTARG in
		    (conf) run_configure ;;
		    (conf_only) only=yes; run_configure ;;
		    (build) run_build ;;
		    (build_only) only=yes; run_build ;;
		    (check) run_check ;;
		    (check_only) only=yes; run_check ;;
		    (install) run_install ;;
		    (install_only) only=yes; run_install ;;
		    (upd_list) run_update ;;
		    (help|usage) usage ;;
		    (version) show_version ;;
		    (*)
                        echo $ouname: error: bad option: --$OPTARG >&2
			exit 2
			;;
		esac
		;;
	    (c) run_configure ;;
	    (C) only=yes; run_configure ;;
	    (b) run_build ;;
	    (B) only=yes; run_build ;;
	    (k) run_check ;;
	    (K) only=yes; run_check ;;
	    (i) run_install ;;
	    (I) only=yes; run_install ;;
	    (h) usage ;;
	    (u) run_update ;;
	    (V) show_version ;;
	    (*)
                echo $ourname: error: bad option: -$OPTARG >&2
		exit 2
		;;
	esac
    done
    shift $(( $OPTIND - 1 ))
else
    # There were no cmdline args given, just run from configure onwards
    only=no			# this should be "no" already, but make sure
    run_configure
fi

## build ends here