Cross Reference: /opengrok/OpenGrok

	OpenGrok revision d2a02e104622a26dd90fa88f4f17188f2039809f
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#!/bin/sh
b0e8629055a766d4555a005a283c2889a5974945Mark Andrews#
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# OpenGrok Wrapper (initial setup and cron job updating)
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# Supported Operating Systems:
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#   - Solaris 10  (SunOS 5.10)
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#   - OpenSolaris (SunOS 5.11)
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#   - Debian      (Linux)
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# Supported Deployment Engines
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#   - Tomcat 6
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#   - Glassfish
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# Supported Environment Variables :
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#   - OPENGROK_NON_INTERACTIVE    Suppress Progress and Warnings Messages
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#   - OPENGROK_STANDARD_ENV       Run Time Shell Environment (Shell Script)
c247e3f281613fabe1af362e9f3157e35ebbe52cMark Andrews#   - OPENGROK_CONFIGURATION      User Configuration (Shell Script)
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# Supported Environment Variables for configuring the default setup
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#   - OPENGROK_DISTRIBUTION_BASE  Base Directory of the OpenGrok Distribution
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#   - OPENGROK_INSTANCE_BASE      Base Directory of the OpenGrok User Data Area
e21a2904f02a03fa06b6db04d348f65fe9c67b2bMark Andrews#   - EXUBERANT_CTAGS             Full Path to Exuberant CTags
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#   - JAVA_HOME                   Full Path to Java Installation Root
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#   - OPENGROK_APP_SERVER         Application Server ("Tomcat" or "Glassfish")
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#   - OPENGROK_WAR_TARGET_TOMCAT  Tomcat Specific WAR Target Directory
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#   - OPENGROK_WAR_TARGET_GLASSFISH Glassfish Specific WAR Target Directory
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#   - OPENGROK_WAR_TARGET         Fallback WAR Target Directory
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#   - OPENGROK_TOMCAT_BASE        Base Directory for Tomcat (contains webapps)
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#   - OPENGROK_GLASSFISH_BASE     Base Directory for Glassfish (contains domains)
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#   - OPENGROK_GLASSFISH_DOMAIN   Preferred Glassfish Domain Name
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# Usage
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark AndrewsUsage()
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews{
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    echo 1>&2
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    echo "Usage: ${0} <deploy|update|updateQuietly|updateConfiguration|usage>" 1>&2
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    echo 1>&2
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    echo "  Optional environment variables:" 1>&2
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    echo "    OPENGROK_CONFIGURATION - location of your configuartion" 1>&2
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    echo "      e.g. $ OPENGROK_CONFIGURATION=/var/opengrok/myog.conf ${0} ... " 1>&2
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    echo 1>&2
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    echo "    See the code for more information on configuration options" 1>&2
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    echo 1>&2
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    exit 1
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews}
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# Runtime Configuration
12351e0500dff39f56844401fd191a36bcc4a7adMark Andrews#
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark AndrewsOS_NAME="`/bin/uname -s`"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark AndrewsOS_VERSION="`/bin/uname -r`"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# Default Instance Configuration
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark AndrewsDefaultInstanceConfiguration()
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews{
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # Use the built-in defaults. This section can be copied to its own
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # file and tailored to your local requirements. Then simply set
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # OPENGROK_CONFIGURATION=/path/to/your/configuration, before using
c247e3f281613fabe1af362e9f3157e35ebbe52cMark Andrews    # this wrapper. It will save you hand editing in your settings
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # on each new release. A sample cron(1M) entry might look like:
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # 15 0 * * * OPENGROK_CONFIGURATION=/pkgs/etc/OpenGrok.sh /pkgs/sbin/OpenGrok updateQuietly
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # Note: It is not really possible to ever provided defaults for
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # these values which will run in every UNIX-like environment.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # So I have provided a set which are functional for a given
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # environment on which you can based you own configuration.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # This has been updated to support more environment variables and
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # operating systems, if you have any reasonably generic
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # improvements please feel free to submit a patch.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    OPENGROK_INSTANCE_BASE="${OPENGROK_INSTANCE_BASE:-/var/opengrok}"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
12351e0500dff39f56844401fd191a36bcc4a7adMark Andrews    if [ -z "${OPENGROK_DISTRIBUTION_BASE}" ]
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    then
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews        if [ -d "dist" -a -f "dist/opengrok.jar" -a -f "dist/source.war" ]
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews        then
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews            # Handle Developer Build Environments
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews            OPENGROK_DISTRIBUTION_BASE="`pwd`/dist"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews        else
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews            # Handle Binary Distributions
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews            OPENGROK_DISTRIBUTION_BASE="`pwd`"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews        fi
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    fi
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # REQUIRED: Source Code/Repository Root
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    #           (your source code or the root of all repositories)
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    SRC_ROOT="${OPENGROK_INSTANCE_BASE}/src"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # REQUIRED: OpenGrok Generate Data Root
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    #           (for Lucene index and hypertext cross-references)
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    #           This area is rebuilt by "update" / "updateQuietly"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    DATA_ROOT="${OPENGROK_INSTANCE_BASE}/data"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # OPTIONAL: User Provided Source Path to Description Mapping (Tab Separated Value)
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    #           (The user maintained source of the generated EftarFile file)
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    PATH_DESC="${OPENGROK_INSTANCE_BASE}/etc/paths.tsv"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # REQUIRED: XML Configuration
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    #           (the configuration used by Web/GUI interfaces)
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    XML_CONFIGURATION="${OPENGROK_INSTANCE_BASE}/etc/configuration.xml"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # REQUIRED: Java Archive of OpenGrok (Installation Location)
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    OPENGROK_JAR="${OPENGROK_INSTANCE_BASE}/opengrok.jar"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # REQUIRED(deploy): Java Archive of OpenGrok (Distribution Location)
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    #           (user building from source code will find this and other key
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    #            files in the "dist" directory after the build is completed)
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    OPENGROK_DIST_JAR="${OPENGROK_DISTRIBUTION_BASE}/opengrok.jar"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # REQUIRED(deploy): Web Archive of OpenGrok (Distribution Location)
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    #           (user building from source code will find this and other key
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    #            files in the "dist" directory after the build is completed)
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    OPENGROK_DIST_WAR="${OPENGROK_DISTRIBUTION_BASE}/source.war"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # REQUIRED: Exuberant CTags (http://ctags.sf.net)
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    EXUBERANT_CTAGS="${EXUBERANT_CTAGS:-`FindExuberantCTags`}"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # REQUIRED: Java Home
c247e3f281613fabe1af362e9f3157e35ebbe52cMark Andrews    JAVA_HOME="${JAVA_HOME:-`FindJavaHome`}"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    export JAVA_HOME
c247e3f281613fabe1af362e9f3157e35ebbe52cMark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # REQUIRED: Java Virtual Machine
c247e3f281613fabe1af362e9f3157e35ebbe52cMark Andrews    JAVA="${JAVA:-$JAVA_HOME/bin/java}"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # OPTIONAL: Scanning Options (for Mercurial repositories)
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    SCAN_FOR_REPOSITORY="-S"
c247e3f281613fabe1af362e9f3157e35ebbe52cMark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # OPTIONAL: Full Path to History Utilities
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    HG="`Which hg`"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    CVS="`Which cvs`"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    SVN="`Which svn`"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    SCCS="`Which sccs`"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # OPTIONAL: Override Built-in Properties
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # Assumption: We should not set properties to the empty string
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    PROPERTIES="\
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews${HG:+-Dorg.opensolaris.opengrok.history.Mercurial=$HG} \
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews${CVS:+-Dorg.opensolaris.opengrok.history.cvs=$CVS} \
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews${SVN:+-Dorg.opensolaris.opengrok.history.Subversion=$SVN} \
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews${SCCS:+-Dorg.opensolaris.opengrok.history.SCCS=$SCCS} \
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # OPTIONAL: JVM Options
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    #JAVA_OPTS="-server -Xmx1024m"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
12351e0500dff39f56844401fd191a36bcc4a7adMark Andrews    # DELIVERED: An update program for EftarFile
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # Usage: <class> inputFile [inputFile ...] outputFile
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # EftarFile == An Extremely Fast Tagged Attribute Read-only File System
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    EFTAR_UPDATE="org.opensolaris.opengrok.web.EftarFile"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # HARDCODED: Generated EftarFile (See web/*.jsp)
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    EFTAR_OUTPUT_FILE="${DATA_ROOT}/index/dtags.eftar"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # Be Quiet? (set indirectly by command line arguments in the main program)
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    QUIET=
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    # or alternatively, Be Verbose!
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    #VERBOSE="-v"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews}
12351e0500dff39f56844401fd191a36bcc4a7adMark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# Helper Functions - Logging
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews#
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# In general, non-interactive use like cron jobs and automated
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# installation environments should not generate unnecessary
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# progress information or warnings, as usage and configuration
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# will have generally been debugged prior to automation.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews#
12351e0500dff39f56844401fd191a36bcc4a7adMark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark AndrewsProgress()
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews{
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    if [ -z "${OPENGROK_NON_INTERACTIVE}" ]
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    then
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews        echo "${@}"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    fi
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews}
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark AndrewsWarning()
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews{
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    if [ -z "${OPENGROK_NON_INTERACTIVE}" ]
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    then
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews        echo "WARNING: ${@}" 1>&2
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    fi
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews}
4abdfc917e6635a7c81d1f931a0c79227e72d025Mark Andrews
4abdfc917e6635a7c81d1f931a0c79227e72d025Mark AndrewsError()
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews{
4abdfc917e6635a7c81d1f931a0c79227e72d025Mark Andrews    echo "ERROR: ${@}" 1>&2
4abdfc917e6635a7c81d1f931a0c79227e72d025Mark Andrews}
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark AndrewsFatalError()
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews{
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    echo 1>&2
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews    echo "FATAL ERROR: ${@} - Aborting!" 1>&2
    echo 1>&2
    ${DO} exit 2
}

#
# Helper Functions - Autodetection of Runtime Environment
#

Which()
{
    path="`which ${1} 2>/dev/null`"

    if [ -x "${path}" ]
    then
        echo "${path}"
    fi
}

FindExuberantCTags()
{
    case "${OS_NAME}:${OS_VERSION}" in
        SunOS:5.10) commandName=""                ;;
        SunOS:5.11) commandName="exctags"         ;;
        Linux:*)    commandName="ctags-exuberant" ;;
        *)          commandName=""                ;;
    esac

    if [ -z "${commandName}" ]
    then
        Error "Unable to determine Exuberant CTags command name" \
            "for ${OS_NAME} ${OS_VERSION}"
        return
    fi

    Which "${commandName}"
}

FindJavaHome()
{
    case "${OS_NAME}:${OS_VERSION}" in
        SunOS:5.10) javaHome="/usr/jdk/instances/jdk1.6.0" ;;
        SunOS:5.11) javaHome="/usr/jdk/latest"             ;;
        Linux:*)    javaHome="/usr/lib/jvm/java-6-sun/bin" ;;
        *)          javaHome=""                            ;;
    esac

    if [ -z "${javaHome}" ]
    then
        Error "Unable to determine Java 6 Home" \
              "for ${OS_NAME} ${OS_VERSION}"
        return
    fi

    if [ ! -d "${javaHome}" ]
    then
        Error "Missing Java Home ${javaHome}"
        return
    fi

    echo "${javaHome}"
}

FindApplicationServerType()
{
    # Use this function to determine which environment the deploy the
    # web application function into. Some users (especially
    # developers) will have many deployment environments or will wish
    # to specify directly the application server to deploy to.

    # Either use the environment variable OPENGROK_APP_SERVER or
    # reimplement this function in your configuration file (as
    # specified by OPENGROK_CONFIGURATION)

    if [ -n "${OPENGROK_APP_SERVER}" ]
    then
        echo "${OPENGROK_APP_SERVER}"
        return
    fi

    # This implementation favours Tomcat, but needs a lot of work,
    # especially if Glassfish is perferrerd or it is under the control
    # of SMF (Service Management Facility)

    # Maybe a better implementation would be to call Application
    # Server specific WAR Directory and see if they exist.

    if [    -d "/var/tomcat6/webapps"     \
         -o -d "/var/lib/tomcat6/webapps" \
       ]
    then
        echo "Tomcat"
        return
    fi

    if [ -x "/etc/init.d/appserv" -a -d "/var/appserver/domains" ]
    then
        echo "Glassfish"
        return
    fi

    # Assume Tomcat
    echo "Tomcat"
}

DetermineWarDirectoryTomcat()
{
    if [ -n "${OPENGROK_WAR_TARGET_TOMCAT}" ]
    then
        echo "${OPENGROK_WAR_TARGET_TOMCAT}"
        return
    elif [ -n "${OPENGROK_WAR_TARGET}" ]
    then
        echo "${OPENGROK_WAR_TARGET}"
        return
    fi

    for prefix in               \
        ${OPENGROK_TOMCAT_BASE} \
        /var/tomcat6            \
        /var/lib/tomcat6        \

    do
        if [ -d "${prefix}/webapps" ]
        then
            echo "${prefix}/webapps"
            return
        fi
    done
}

DetermineWarDirectoryGlassfish()
{

    if [ -n "${OPENGROK_WAR_TARGET_GLASSFISH}" ]
    then
        echo "${OPENGROK_WAR_TARGET_GLASSFISH}"
        return
    elif [ -n "${OPENGROK_WAR_TARGET}" ]
    then
        echo "${OPENGROK_WAR_TARGET}"
        return
    fi

    for prefix in                       \
        ${OPENGROK_GLASSFISH_BASE}      \
        /var/appserver                  \

    do
        if [ -d "${prefix}/domains" ]
        then
            if [ -z "${domainDirectory}" ]
            then
                domainDirectory="${prefix}/domains"
            fi
        fi
    done

    if [ -z "${domainDirectory}" ]
    then
        return
    fi

    # User Specified Domain
    if [ -n "${OPENGROK_GLASSFISH_DOMAIN}" ]
    then
        directory="${domainDirectory}/${OPENGROK_GLASSFISH_DOMAIN}/autodeploy"

        if [ ! -d "${directory}" ]
        then
            FatalError "Missing Specified Glassfish Domain ${OPENGROK_GLASSFISH_DOMAIN}"
        fi

        echo "${directory}"
        return
    fi

    # Arbitrary Domain Selection
    firstDomain=`ls -1 ${domainDirectory} | head -1`

    if [ -z "${firstDomain}" ]
    then
        FatalError "Failed to dynamically determine Glassfish Domain from ${domainDirectory}"
    fi

    echo "${domainDirectory}/${firstDomain}/autodeploy"
}

#
# Implementation
#
# The variable "DO" can usefully be set to "echo" to aid in script debugging
#

LoadStandardEnvironment()
{
    # Setup a standard execution environment (if required)

    OPENGROK_STANDARD_ENV="${OPENGROK_STANDARD_ENV:-/pkgs/sbin/CronExecutionEnvironment.sh}"

    if [ -f "${OPENGROK_STANDARD_ENV}" ]
    then
        Progress "Loading ${OPENGROK_STANDARD_ENV} ..."
        . "${OPENGROK_STANDARD_ENV}"
    fi
}

LoadInstanceConfiguration()
{
    # Note: As all functions have been defined by the time this routine
    # is called, your configuration can, if desired, override functions
    # in addition to setting the variables mentioned in the function
    # DefaultInstanceConfiguration(), this maybe useful to override
    # functionality used to determine the default deployment environment
    # find dependencies or validate the configuration, for example.

    if [ -n "${OPENGROK_CONFIGURATION}" -a -f "${OPENGROK_CONFIGURATION}" ]
    then
        # Load the Local OpenGrok Configuration Environment
        Progress "Loading ${OPENGROK_CONFIGURATION} ..."
        . "${OPENGROK_CONFIGURATION}"
    else
        Progress "Loading the default instance configuration ..."
        DefaultInstanceConfiguration
    fi
}

ValidateConfiguration()
{
    if [ ! -x "${EXUBERANT_CTAGS}" ]
    then
        FatalError "Missing Dependent Application - Exuberant CTags"
    fi

    if [ ! -d "${SRC_ROOT}" ]
    then
        FatalError "OpenGrok Source Path ${SRC_ROOT} doesn't exist"
    fi
}

CreateRuntimeRequirements()
{
    if [ ! -d "${DATA_ROOT}" ]
    then
        Warning  "OpenGrok Generated Data Path ${DATA_ROOT} doesn't exist"
        Progress "  Attempting to create generated data directory ... "
        ${DO} mkdir -p "${DATA_ROOT}"
    fi
}

StdInvocation()
{
    ${DO} ${JAVA} ${JAVA_OPTS} ${PROPERTIES}                    \
        -jar ${OPENGROK_JAR}                                    \
        ${SCAN_FOR_REPOSITORY} ${VERBOSE} ${QUIET}              \
        ${EXUBERANT_CTAGS:+-c} ${EXUBERANT_CTAGS}               \
        -s ${SRC_ROOT} -d ${DATA_ROOT}                          \
        "${@}"
}

UpdateGeneratedConfiguration()
{
    StdInvocation -W ${XML_CONFIGURATION}
}

UpdateGeneratedData()
{
    StdInvocation -H
}

UpdateDescriptionCache()
{
    # OPTIONAL : Update the EftarFile data

    if [ -n "${PATH_DESC}" -o -s "${PATH_DESC}" ]
    then
        ${DO} ${JAVA} -classpath ${OPENGROK_JAR}                \
            ${EFTAR_UPDATE} ${PATH_DESC} ${EFTAR_OUTPUT_FILE}
    fi
}

OpenGrokUsage()
{
    ${DO} ${JAVA} ${JAVA_OPTS} -jar ${OPENGROK_JAR} '-?'
}

DeployWar()
{
    applicationServer="`FindApplicationServerType`"

    case "${applicationServer}" in

        Tomcat)    warTarget="`DetermineWarDirectoryTomcat`"    ;;
        Glassfish) warTarget="`DetermineWarDirectoryGlassfish`" ;;

        *) FatalError "Unsupported Application Server ${applicationServer}" ;;

    esac

    if [ -z "${warTarget}" ]
    then
        FatalError "Unable to determine Deployment Directory for ${applicationServer}"
    fi

    if [ ! -f "${OPENGROK_DIST_WAR}" ]
    then
        FatalError "Missing Web Application Archive ${OPENGROK_DIST_WAR}"
    fi

    if [ ! -d "${warTarget}" ]
    then
        FatalError "Missing Deployment Directory ${warTarget}"
    fi

    Progress "Installing ${OPENGROK_DIST_WAR} to ${warTarget} ..."
    ${DO} cp "${OPENGROK_DIST_WAR}" "${warTarget}/"
    if [ $? != 0 ]
    then
        FatalError "Web Application Installation FAILED"
    fi

    Progress
    Progress "Start your application server (${applicationServer}), if it is not already"
    Progress "running, or wait until it loads the just installed web application."
    Progress
    Progress "OpenGrok should be available on <HOST>:<PORT>/source"
    Progress "  where HOST and PORT are configured in ${applicationServer}."
    Progress
}

#
# Main Program
#

if [ $# -ne 1 ]
then
    Usage
fi

LoadStandardEnvironment

LoadInstanceConfiguration

ValidateConfiguration

CreateRuntimeRequirements

case "${1}" in

    deploy)
        DeployWar
        ;;

    update)
        UpdateGeneratedData
        UpdateDescriptionCache
        ;;

    updateQuietly)
        QUIET="-q"
        VERBOSE=""
        UpdateGeneratedData
        UpdateDescriptionCache
        ;;

    updateConfiguration)
        UpdateGeneratedConfiguration
        ;;

    usage)
        OpenGrokUsage
        ;;

    *)
        Usage
        ;;

esac

#
# End of File
#