#!/bin/sh
#-
# Copyright (c) 2004 FreeBSD GNOME Team <freebsd-gnome@FreeBSD.org>
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in the
#    documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
# Heh. "Tort."
#
# $Id: gnomelogalyzer.sh,v 1.4 2004/06/06 20:27:19 marcus Exp $
#


# You can set the environment variable VERBOSE to something non-null
# to see debugging messages.  They're probably not all that exciting.


help(){
	echo "Usage: `basename $0` BUILDLOG"
	echo
	echo "Where BUILDLOG is a log of stdout and stderr from a"
	echo "failed GNOME ports build."
	echo "For example, \"make 2>&1 | tee /path/to/BUILDLOG\" for sh or"
	echo "\"make |& tee /path/to/BUILDLOG\" for csh."
}


debug(){
	if [ -n "${VERBOSE}" ]; then
		if [ "$1" = "-n" ]; then
			echo -n "$2"
		else
			echo "$1"
		fi
	fi
}


# Are we blue in the face yet?
soln_portupgrade(){
    	if echo "$1" | grep -q "^-f" ; then
		echo
		echo "To correct this problem, make sure that sysutils/portupgrade is installed, and then run the command \"portupgrade $1\"." | fmt 75 79
	else
		if [ -n "$1" ]; then
			specific="either run \"portupgrade $1\", or "
		fi
		echo
		echo "To correct this problem, make sure that sysutils/portupgrade is installed, and then ${specific}upgrade all out-of-date ports with the command \"portupgrade -a\"." | fmt 75 79
	fi
}

###########
#
# main()

echo; # for good measure.
# check to make sure that the build log has been specified
if [ -z "$1" -o ! -f "$1" ]; then
	echo "Error: Please supply a valid build log."
	help
	exit 1
fi
buildlog="$1"


######
#
# TEST: Invalid pkg-config version
#
# SOLUTION: portupgrade pkgconfig

debug -n "Checking pkg-config version... "
if grep -q '\*\*\* Your version of pkg-config is too old.' ${buildlog} ; then
	echo "You have an outdated version of pkg-config installed."
	soln_portupgrade "pkgconfig"
	exit
else
	debug "OK"
fi

#####
#
# TEST: Out-of-date libraries
#
# SOLUTION: portupgrade

debug -n "Checking for out-of-date libraries... "
if grep -qE 'error: Library requirements (.*) not met;' ${buildlog} ; then
	echo "One or more GNOME libraries are too out-of-date."
	soln_portupgrade
	exit
else
	debug "OK"
fi

#####
#
# TEST: b0rked intltool
#
# SOLUTION: portupgrade -f intltool

debug -n "Checking for incomplete intltool installation... "
if grep -q 'error: XML::Parser perl module is required for intltool' ${buildlog} ; then
	echo "Your installation of intltool is incomplete."
	soln_portupgrade "-f intltool"
	echo
	echo "If portupgrade does not work, and you recently updated Perl, you should reinstall all of your Perl modules.  The best way to do this is with the command: portupgrade -f p5-\*" | fmt 75 79
	exit
else
	debug "OK"
fi

#####
#
# Catch-all
#

debug "Giving up..."
echo "The cause of your build failure is not known to `basename $0`.  Before e-mailing the build log to the FreeBSD GNOME team at freebsd-gnome@FreeBSD.org, TRY EACH OF THE FOLLOWING:" | fmt 75 79
echo
echo "	* Make sure that you are generating the logfile with something similar"
echo "	  to \"make 2>&1 | tee /path/to/logfile\" (sh) or"
echo "	  \"make |& tee /path/to/logfile\" (csh)"
echo "	* Make sure your cvsup(1) configuration file specifies the 'ports-all'"
echo "	  collection"
echo "	* Run cvsup(1) and attempt the build again"
echo "	* Check /usr/ports/UPDATING for information pertinent to your build"
echo "	  failure"
echo "	* 99% of the commonly reported build failures can be solved by"
echo "	  running \"portupgrade -a\""
echo "	* Read the FAQs at http://www.FreeBSD.org/gnome/"
echo "	* Search the archives of freebsd-gnome@FreeBSD.org.  Archives can be"
echo "	  searched at http://lists.freebsd.org/pipermail/freebsd-gnome/"
echo
echo "If you have not performed each of the above suggestions, don't bother asking for help.  The chances are good that you'll simply be told to perform one of the aforementioned steps." | fmt 75 79

exit

# Here there be tacos.