OpenGrok revision 4f3c0816485669143aa54f1c6461fcb47cf5bc5c
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson#!/bin/sh
665a24faf6b3711e4012ac02ae5f0981c093ac1eTinderbox User#
75c0816e8295e180f4bc7f10db3d0d880383bc1cMark Andrews# OpenGrok Wrapper (initial setup and cron job updating)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein#
4a14ce5ba00ab7bc55c99ffdcf59c7a4ab902721Automatic Updater# Supported Operating Systems:
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson# - Solaris 10 (SunOS 5.10)
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson# - Solaris 11 (SunOS 5.11)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - Debian (Linux)
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews#
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews# Supported Deployment Engines:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - Tomcat 6
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews# - Tomcat 5.5
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews# - Glassfish
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews#
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews# Supported Environment Variables:
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson# - OPENGROK_NON_INTERACTIVE Suppress Progress and Warnings Messages (*)
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User# - OPENGROK_STANDARD_ENV Run Time Shell Environment (Shell Script)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - OPENGROK_CONFIGURATION User Configuration (Shell Script)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein#
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# Supported Environment Variables for configuring the default setup:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - OPENGROK_DISTRIBUTION_BASE Base Directory of the OpenGrok Distribution
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User# - OPENGROK_INSTANCE_BASE Base Directory of the OpenGrok User Data Area
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - EXUBERANT_CTAGS Full Path to Exuberant CTags
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User# - JAVA_HOME Full Path to Java Installation Root
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# - JAVA Full Path to java binary
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - JAVA_OPTS Java options
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - OPENGROK_APP_SERVER Application Server ("Tomcat" or "Glassfish")
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - OPENGROK_WAR_TARGET_TOMCAT Tomcat Specific WAR Target Directory
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - OPENGROK_WAR_TARGET_GLASSFISH Glassfish Specific WAR Target Directory
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - OPENGROK_WAR_TARGET Fallback WAR Target Directory
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - OPENGROK_TOMCAT_BASE Base Directory for Tomcat (contains webapps)
b46346eb3026ba4bebc093bc93cfe159131e541eTinderbox User# - OPENGROK_GLASSFISH_BASE Base Directory for Glassfish
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# (contains domains)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - OPENGROK_GLASSFISH_DOMAIN Preferred Glassfish Domain Name
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - OPENGROK_VERBOSE Enable Verbose Mode in opengrok.jar (*)
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User# - OPENGROK_PROGRESS Shows progress in %(percentage) of working
5fa6a064b8301e4f274bd132fd577def59e4fb4cTinderbox User# through project, it's good to have Verbose
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User# Mode enabled too, cost of this is one more
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# traversal of the project before indexing it(*)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - OPENGROK_REMOTE_REPOS Disable History Cache for (remote)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# Repositories (*)
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User# - OPENGROK_SCAN_REPOS Disable Scan for repositories (*)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - OPENGROK_SCAN_DEPTH how deep should scanning for repos go
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# (by default 3 directories from SRC_ROOT)
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User# - OPENGROK_WEBAPP_CFGADDR Web app address to send configuration to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# (use "none" to avoid sending it to web app)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - OPENGROK_WPREFIX Disable wildcard prefix search query
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User# support (*)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - OPENGROK_DERBY if set, then indexer tries to use derby as
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# historycache (see derby command of this
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# script)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - READ_XML_CONFIGURATION file with read only configuration
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews# - temporary workaround for bug # 327
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User#
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# Notes:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# (*) Any Non-Empty String will enable these options
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein#
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein#
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User# Copyright (c) 2008, 2012, Oracle and/or its affiliates. All rights reserved.
03c0efc6892ef2ed17338b2ecbb2c5f23fbad0c9Tinderbox User#
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User#
d8620c7234281056fdfd2ee40cf16636b8281092Tinderbox User# Print usage to stderr and exit.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein#
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinUsage()
b49958b502ee45022010a0b1bed3968f598895a4Automatic Updater{
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User progname=`basename $0`
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein exec >&2
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User echo 1>&2
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "Usage: ${progname} <deploy|derby|update|updateQuietly|usage>" 1>&2
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo " ${progname} index [<directory>]" 1>&2
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo 1>&2
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo " Optional environment variables:" 1>&2
b3cbb2f1ad021349e89807f3492df6e4e679cd56Mark Andrews echo " OPENGROK_CONFIGURATION - location of your configuration" 1>&2
b3cbb2f1ad021349e89807f3492df6e4e679cd56Mark Andrews echo " e.g. $ OPENGROK_CONFIGURATION=/var/opengrok/myog.conf ${0} ... " 1>&2
665a24faf6b3711e4012ac02ae5f0981c093ac1eTinderbox User echo 1>&2
b49958b502ee45022010a0b1bed3968f598895a4Automatic Updater echo " See the code for more information on configuration options /" \
b49958b502ee45022010a0b1bed3968f598895a4Automatic Updater "variables" 1>&2
b3cbb2f1ad021349e89807f3492df6e4e679cd56Mark Andrews echo 1>&2
b3cbb2f1ad021349e89807f3492df6e4e679cd56Mark Andrews exit 1
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein}
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User
5fa6a064b8301e4f274bd132fd577def59e4fb4cTinderbox User#
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# Runtime Configuration
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User#
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinif [ -f "/bin/uname" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinthen
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein OS_NAME="`/bin/uname -s`"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein OS_VERSION="`/bin/uname -r`"
61e1dc26d62c2a0059e3ca7efe2ad0f4a5b8df92Mark Andrewselse
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein OS_NAME="`/usr/bin/uname -s`"
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User OS_VERSION="`/usr/bin/uname -r`"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinfi
d8620c7234281056fdfd2ee40cf16636b8281092Tinderbox User
d8620c7234281056fdfd2ee40cf16636b8281092Tinderbox User# TODO: Handle symlinks correctly (especially in ${0})
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox UserSCRIPT_DIRECTORY="`dirname ${0}`"
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox UserSCRIPT_DIRECTORY="`cd ${SCRIPT_DIRECTORY}; pwd`"
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User#
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User# Default Instance Configuration
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User#
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox UserDefaultInstanceConfiguration()
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User{
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User # Use the built-in defaults. This section can be copied to its own
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User # file and tailored to your local requirements. Then simply set
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User # OPENGROK_CONFIGURATION=/path/to/your/configuration, before using
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User # this wrapper. It will save you hand editing in your settings
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User # on each new release. A sample cron(1M) entry might look like:
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User # 15 0 * * * OPENGROK_CONFIGURATION=/pkgs/etc/OpenGrok.sh /pkgs/sbin/OpenGrok updateQuietly
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User # Note: It is not really possible to ever provided defaults for
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User # these values which will run in every UNIX-like environment.
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User # So I have provided a set which are functional for a given
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User # environment on which you can based you own configuration.
d8620c7234281056fdfd2ee40cf16636b8281092Tinderbox User
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # This has been updated to support more environment variables and
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # operating systems, if you have any reasonably generic
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User # improvements please feel free to submit a patch.
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein OPENGROK_INSTANCE_BASE="${OPENGROK_INSTANCE_BASE:-/var/opengrok}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User LOGGER_CONFIG_FILE="logging.properties"
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User if [ -z "${OPENGROK_DISTRIBUTION_BASE}" ]
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User then
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User if [ -d "${SCRIPT_DIRECTORY}/dist" -a \
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User -f "${SCRIPT_DIRECTORY}/dist/opengrok.jar" -a \
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User -f "${SCRIPT_DIRECTORY}/dist/source.war" \
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # Handle Developer Build Environments
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein OPENGROK_DISTRIBUTION_BASE="${SCRIPT_DIRECTORY}/dist"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein LOGGER_CONF_SOURCE="${SCRIPT_DIRECTORY}/${LOGGER_CONFIG_FILE}"
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User else
5fa6a064b8301e4f274bd132fd577def59e4fb4cTinderbox User # Handle Binary Distributions
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein OPENGROK_DISTRIBUTION_BASE="${SCRIPT_DIRECTORY}/../lib"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein LOGGER_CONF_SOURCE="${OPENGROK_DISTRIBUTION_BASE}/../doc/"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein LOGGER_CONF_SOURCE="${LOGGER_CONF_SOURCE}${LOGGER_CONFIG_FILE}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # REQUIRED: Source Code/Repository Root
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # (your source code or the root of all repositories)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein SRC_ROOT="${OPENGROK_INSTANCE_BASE}/src"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # REQUIRED: OpenGrok Generate Data Root
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # (for Lucene index and hypertext cross-references)
a1b05dea35aa30b152a47115e18bbe679d3fcf19Mark Andrews # This area is rebuilt by "update" / "updateQuietly"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein DATA_ROOT="${OPENGROK_INSTANCE_BASE}/data"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User # OPTIONAL: User Provided Source Path to Description Mapping (Tab Separated Value)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # (The user maintained source of the generated EftarFile file)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein PATH_DESC="${OPENGROK_INSTANCE_BASE}/etc/paths.tsv"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # REQUIRED: XML Configuration
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews # (the configuration used by Web/GUI interfaces)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein XML_CONFIGURATION="${OPENGROK_INSTANCE_BASE}/etc/configuration.xml"
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # OPTIONAL: read only XML config, if it exists, it will be read
1c09d68dfd18b6e839c8cd68b78c11b3ccca4160Automatic Updater READ_XML_CONFIGURATION="${READ_XML_CONFIGURATION:-}"
1c09d68dfd18b6e839c8cd68b78c11b3ccca4160Automatic Updater
1c09d68dfd18b6e839c8cd68b78c11b3ccca4160Automatic Updater if [ -f "${READ_XML_CONFIGURATION}" ] ; then
1c09d68dfd18b6e839c8cd68b78c11b3ccca4160Automatic Updater READ_XML_CONF="-R ${READ_XML_CONFIGURATION}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # REQUIRED: Logger Configuration
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User LOGGER_CONFIG_PATH="${OPENGROK_INSTANCE_BASE}/${LOGGER_CONFIG_FILE}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein LOGGER_PROPERTIES="-Djava.util.logging.config.file=${LOGGER_CONFIG_PATH}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # REQUIRED: Java Archive of OpenGrok (Installation Location)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein OPENGROK_JAR="${OPENGROK_DISTRIBUTION_BASE}/opengrok.jar"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # REQUIRED(deploy): Web Archive of OpenGrok (Distribution Location)
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User # (user building from source code will find this and other key
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # files in the "dist" directory after the build is completed)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein OPENGROK_DIST_WAR="${OPENGROK_DISTRIBUTION_BASE}/source.war"
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # REQUIRED: Exuberant CTags (http://ctags.sf.net)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein EXUBERANT_CTAGS="${EXUBERANT_CTAGS:-`FindExuberantCTags`}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # REQUIRED: Java Home
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein JAVA_HOME="${JAVA_HOME:-`FindJavaHome`}"
f6da30bb5447c23d880b09f601441e70c5313557Mark Andrews export JAVA_HOME
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # REQUIRED: Java Virtual Machine
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein JAVA="${JAVA:-$JAVA_HOME/bin/java}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # DEVELOPMENT: Debug option, if enabled current indexer will listen on the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # port 8010 until a debugger connects
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein #JAVA_DEBUG="-agentlib:jdwp=transport=dt_socket"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein #JAVA_DEBUG="$JAVA_DEBUG,server=y,address=8010,suspend=y"
a057e8e33baa5fa369be28a9680585200ce3ff73Mark Andrews
a057e8e33baa5fa369be28a9680585200ce3ff73Mark Andrews # OPTIONAL: Ignore these patterns as names of files or directories
665a24faf6b3711e4012ac02ae5f0981c093ac1eTinderbox User #IGNORE_PATTERNS="-i dummy"
8c9957e63274e6ea44d182703116307b1a65dabbMark Andrews
a057e8e33baa5fa369be28a9680585200ce3ff73Mark Andrews # OPTIONAL: Enable Projects
b46346eb3026ba4bebc093bc93cfe159131e541eTinderbox User # (Every directory in SRC_ROOT is considered a separate project)
b46346eb3026ba4bebc093bc93cfe159131e541eTinderbox User ENABLE_PROJECTS="-P"
b46346eb3026ba4bebc093bc93cfe159131e541eTinderbox User
b46346eb3026ba4bebc093bc93cfe159131e541eTinderbox User # OPTIONAL: Scanning Options (for Mercurial repositories)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein SCAN_FOR_REPOSITORY="-S"
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews if [ -n "${OPENGROK_SCAN_REPOS}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein SCAN_FOR_REPOSITORY=""
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # OPTIONAL: Remote Repository Support (CVS or SVN)
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User # (Can be very time demanding, uncomment if needed)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein REMOTE_REPOSITORIES="-r on"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -n "${OPENGROK_REMOTE_REPOS}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein REMOTE_REPOSITORIES=""
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # OPTIONAL: override depth of scanning for repositories
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -n "${OPENGROK_SCAN_DEPTH}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein SCAN_DEPTH="-z${OPENGROK_SCAN_DEPTH}"
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # OPTIONAL: Allow Leading Wildcard Searches
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # (default: on)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein LEADING_WILDCARD="-a on"
7329012471d165cd3dc4180ad2a0a43de91e7f01Mark Andrews if [ -n "${OPENGROK_WPREFIX}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein LEADING_WILDCARD=""
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # OPTIONAL: Web Site Look & Feel
61e1dc26d62c2a0059e3ca7efe2ad0f4a5b8df92Mark Andrews # (Options: default, offwhite and polished.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # Note the quoting requirements)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein #SKIN='-L "default"'
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # OPTIONAL: Set Maximum Indexed Words Per File
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User # Note, that you might run out of memory, then either increase JVM memory
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # as noted in JAVA_OPTS, or set this limit(if you don't mind opengrok not
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # indexing the rest of the file, once the limit is reached)
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User # (default: unlimited)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein #MAX_INDEXED_WORDS="-m 100000"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # OPTIONAL: Configuration Address (host:port)
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User # (conf/web.xml default is localhost:2424)
5fa6a064b8301e4f274bd132fd577def59e4fb4cTinderbox User WEBAPP_CONFIG=""
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User if [ -n "${OPENGROK_WEBAPP_CFGADDR}" ]; then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein WEBAPP_CONFIG_ADDRESS=${OPENGROK_WEBAPP_CFGADDR}
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ "${OPENGROK_WEBAPP_CFGADDR}" == "none" ]; then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein WEBAPP_CONFIG_ADDRESS=""
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein else
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein WEBAPP_CONFIG_ADDRESS="localhost:2424"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -n "${WEBAPP_CONFIG_ADDRESS}" ]; then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein WEBAPP_CONFIG="-U ${WEBAPP_CONFIG_ADDRESS}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # OPTIONAL: JVM Options
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein JAVA_OPTS="${JAVA_OPTS:--Xmx2048m}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson # OPTIONAL: Full Path to History Utilities
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein HG="`Which hg`"
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User CVS="`Which cvs`"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User SVN="`Which svn`"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein SCCS="`Which sccs`"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User CLEARCASE="`Which cleartool`"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User GIT="`Which git`"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein P4="`Which p4`"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein MTN="`Which mtn`"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User BZR="`Which bzr`"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # OPTIONAL: Override Built-in Properties
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # Assumption: We should not set properties to the empty string
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User PROPERTIES="\
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User${HG:+-Dorg.opensolaris.opengrok.history.Mercurial=$HG} \
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User${CVS:+-Dorg.opensolaris.opengrok.history.cvs=$CVS} \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein${SVN:+-Dorg.opensolaris.opengrok.history.Subversion=$SVN} \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein${SCCS:+-Dorg.opensolaris.opengrok.history.SCCS=$SCCS} \
370c55dfcdc559b8761ef3eb4921498580caf14cAutomatic Updater${CLEARCASE:+-Dorg.opensolaris.opengrok.history.ClearCase=$CLEARCASE} \
370c55dfcdc559b8761ef3eb4921498580caf14cAutomatic Updater${GIT:+-Dorg.opensolaris.opengrok.history.git=$GIT} \
370c55dfcdc559b8761ef3eb4921498580caf14cAutomatic Updater${P4:+-Dorg.opensolaris.opengrok.history.Perforce=$P4} \
370c55dfcdc559b8761ef3eb4921498580caf14cAutomatic Updater${MTN:+-Dorg.opensolaris.opengrok.history.Monotone=$MTN} \
370c55dfcdc559b8761ef3eb4921498580caf14cAutomatic Updater${BZR:+-Dorg.opensolaris.opengrok.history.Bazaar=$BZR} \
370c55dfcdc559b8761ef3eb4921498580caf14cAutomatic Updater"
370c55dfcdc559b8761ef3eb4921498580caf14cAutomatic Updater
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater # OPTIONAL: Store The History Cache in Java DB (derby),
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater # instead of file system (in gzipped xml files).
370c55dfcdc559b8761ef3eb4921498580caf14cAutomatic Updater #
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # Requirements:
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # - derbyclient.jar - See README.txt for more details
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # - Running Derby Server - Defaults to localhost:1527
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User #
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User if [ -n "${OPENGROK_DERBY}" ]
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User then
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User DERBY_HISTORY_CACHE="-D"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User fi
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # DELIVERED: An update program for EftarFile
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # Usage: <class> inputFile [inputFile ...] outputFile
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # EftarFile == An Extremely Fast Tagged Attribute Read-only File System
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User EFTAR_UPDATE="org.opensolaris.opengrok.web.EftarFile"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # HARDCODED: Generated EftarFile (See web/*.jsp)
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User EFTAR_OUTPUT_FILE="${DATA_ROOT}/index/dtags.eftar"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # Be Quiet? (set indirectly by command line arguments in the main program)
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User #QUIET=""
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # or alternatively, Be Verbose!
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User #VERBOSE="-v"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User if [ -n "${OPENGROK_VERBOSE}" ]
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User then
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User VERBOSE="-v"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User QUIET=""
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User fi
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -n "${OPENGROK_PROGRESS}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User PROGRESS="-C"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User fi
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User}
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein#
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# Helper Functions - Logging
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User#
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User# In general, non-interactive use like cron jobs and automated
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User# installation environments should not generate unnecessary
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User# progress information or warnings, as usage and configuration
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# will have generally been debugged prior to automation.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User#
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox UserProgress()
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User{
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User if [ -z "${OPENGROK_NON_INTERACTIVE}" ]
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User then
e68c527dff2f1f7df2a542f8d6f9181a27e05eb7Tinderbox User echo "${@}"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User fi
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User}
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox UserWarning()
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User{
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User if [ -z "${OPENGROK_NON_INTERACTIVE}" ]
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User then
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User echo "WARNING: ${@}" 1>&2
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User fi
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User}
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox UserError()
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User{
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User echo "ERROR: ${@}" 1>&2
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User}
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox UserFatalError()
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User{
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User exec >&2
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User echo ""
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User echo "FATAL ERROR: ${@} - Aborting!"
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User echo ""
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User ${DO} exit 2
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User}
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User#
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User# Helper Functions - Autodetection of Runtime Environment
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User#
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox UserWhich()
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User{
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User path="`which ${1} 2>/dev/null`"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
d9f0b06dc2bba47e3fe63afdf41c638d3517ceffTinderbox User if [ -x "${path}" ]
d9f0b06dc2bba47e3fe63afdf41c638d3517ceffTinderbox User then
d9f0b06dc2bba47e3fe63afdf41c638d3517ceffTinderbox User echo "${path}"
d9f0b06dc2bba47e3fe63afdf41c638d3517ceffTinderbox User fi
a24330c4805a224191ab687d0291963062fe3355Tinderbox User}
d9f0b06dc2bba47e3fe63afdf41c638d3517ceffTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox UserLocateBinary() {
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User for f in $@
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User do
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User file=`which "$f" 2>/dev/null | grep -v '^no '`
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User if test -n "$file" -a -x "$file"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User then
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User echo $file
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User return 0
4fe1df3962f1f37304b6789b2d1a33a70fcb0b28Tinderbox User fi
4fe1df3962f1f37304b6789b2d1a33a70fcb0b28Tinderbox User done
4fe1df3962f1f37304b6789b2d1a33a70fcb0b28Tinderbox User
4fe1df3962f1f37304b6789b2d1a33a70fcb0b28Tinderbox User echo ""
4fe1df3962f1f37304b6789b2d1a33a70fcb0b28Tinderbox User return 1
4fe1df3962f1f37304b6789b2d1a33a70fcb0b28Tinderbox User}
4fe1df3962f1f37304b6789b2d1a33a70fcb0b28Tinderbox User
def82e8de9ff45e29ab21e5aba9a39539138c1f4Tinderbox UserFindExuberantCTags()
def82e8de9ff45e29ab21e5aba9a39539138c1f4Tinderbox User{
def82e8de9ff45e29ab21e5aba9a39539138c1f4Tinderbox User binary=`LocateBinary ctags-exuberant exctags ctags`
def82e8de9ff45e29ab21e5aba9a39539138c1f4Tinderbox User if test $? -eq 1
def82e8de9ff45e29ab21e5aba9a39539138c1f4Tinderbox User then
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User Error "Unable to determine Exuberant CTags command name" \
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User "for ${OS_NAME} ${OS_VERSION}"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User return
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User fi
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
b90c4f0646e61b6cc82bde5a93e400e1015974b8Tinderbox User # Verify that this really is Exuberant Ctags
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User $binary --version 2>&1 | grep "Exuberant Ctags" > /dev/null
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User if test $? -ne 0
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User then
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User Error "Unable to determine Exuberant CTags command name" \
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User "for ${OS_NAME} ${OS_VERSION}\n(${binary} is not Exuberant CTags)"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User return
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User fi
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User echo ${binary}
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User}
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
a3ff24aaa545c45b8c581b2127d02d735aff8881Tinderbox UserFindJavaHome()
a3ff24aaa545c45b8c581b2127d02d735aff8881Tinderbox User{
a3ff24aaa545c45b8c581b2127d02d735aff8881Tinderbox User javaHome=""
a3ff24aaa545c45b8c581b2127d02d735aff8881Tinderbox User case "${OS_NAME}:${OS_VERSION}" in
a3ff24aaa545c45b8c581b2127d02d735aff8881Tinderbox User SunOS:5.10) javaHome="/usr/jdk/instances/jdk1.6.0" ;;
a3ff24aaa545c45b8c581b2127d02d735aff8881Tinderbox User SunOS:5.11) javaHome="/usr/jdk/latest" ;;
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User Linux:*)
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User if [ -f /etc/alternatives/java ]
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User then
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User javaHome=`ls -l /etc/alternatives/java | cut -f 2 -d \> `
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User javaHome=`dirname $javaHome`
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User javaHome=`dirname $javaHome`
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User else
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User for dir in /usr/lib/jvm/sun-jdk-1.6 \
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User /usr/lib/jvm/sun-jre-1.6 \
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User /usr/lib/jvm/java-6-sun
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User do
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User if [ -f ${dir}/bin/java ]
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User then
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User javaHome=$dir
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User break;
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User fi
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User done
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User fi
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User ;;
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User esac
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User if [ -z "${javaHome}" ]
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User then
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User Error "Unable to determine Java 6 Home" \
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User "for ${OS_NAME} ${OS_VERSION}"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User return
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User fi
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User if [ ! -d "${javaHome}" ]
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User then
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User Error "Missing Java Home ${javaHome}"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User return
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User fi
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User echo "${javaHome}"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User}
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox UserFindApplicationServerType()
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User{
78ec962d9828200d18cd0e41b7d6b9792a74923dTinderbox User # Use this function to determine which environment the deploy the
78ec962d9828200d18cd0e41b7d6b9792a74923dTinderbox User # web application function into. Some users (especially
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # developers) will have many deployment environments or will wish
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # to specify directly the application server to deploy to.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # Either use the environment variable OPENGROK_APP_SERVER or
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # reimplement this function in your configuration file (as
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # specified by OPENGROK_CONFIGURATION)
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User if [ -n "${OPENGROK_APP_SERVER}" ]
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User then
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User echo "${OPENGROK_APP_SERVER}"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User return
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User fi
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # This implementation favours Tomcat, but needs a lot of work,
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # especially if Glassfish is perferrerd or it is under the control
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # of SMF (Service Management Facility)
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # Maybe a better implementation would be to call Application
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # Server specific WAR Directory and see if they exist.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User if [ -d "/var/tomcat6/webapps" \
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User -o -d "/var/lib/tomcat6/webapps" \
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User -o -d "/var/lib/tomcat5/webapps" \
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User -o -d "/var/lib/tomcat5.5/webapps" \
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User ]
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User then
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User echo "Tomcat"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User return
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User fi
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User if [ -x "/etc/init.d/appserv" -a -d "/var/appserver/domains" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "Glassfish"
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater return
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater fi
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater # Assume Tomcat
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater echo "Tomcat"
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater}
77dccf2a5d9327d16b4374a135cdb99bdd48620eAutomatic Updater
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox UserDetermineWarDirectoryTomcat()
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein{
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User if [ -n "${OPENGROK_WAR_TARGET_TOMCAT}" ]
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User then
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User echo "${OPENGROK_WAR_TARGET_TOMCAT}"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User return
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User elif [ -n "${OPENGROK_WAR_TARGET}" ]
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "${OPENGROK_WAR_TARGET}"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User return
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User fi
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # Note: the whitespace before 'do' has to be there.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User for prefix in \
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User ${OPENGROK_TOMCAT_BASE} \
78ec962d9828200d18cd0e41b7d6b9792a74923dTinderbox User /var/tomcat6 \
78ec962d9828200d18cd0e41b7d6b9792a74923dTinderbox User /var/lib/tomcat6 \
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User /var/lib/tomcat5 \
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User /var/lib/tomcat5.5
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User do
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User if [ -d "${prefix}/webapps" ]
78ec962d9828200d18cd0e41b7d6b9792a74923dTinderbox User then
78ec962d9828200d18cd0e41b7d6b9792a74923dTinderbox User echo "${prefix}/webapps"
78ec962d9828200d18cd0e41b7d6b9792a74923dTinderbox User return
78ec962d9828200d18cd0e41b7d6b9792a74923dTinderbox User fi
78ec962d9828200d18cd0e41b7d6b9792a74923dTinderbox User done
78ec962d9828200d18cd0e41b7d6b9792a74923dTinderbox User}
78ec962d9828200d18cd0e41b7d6b9792a74923dTinderbox User
78ec962d9828200d18cd0e41b7d6b9792a74923dTinderbox UserDetermineWarDirectoryGlassfish()
78ec962d9828200d18cd0e41b7d6b9792a74923dTinderbox User{
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -n "${OPENGROK_WAR_TARGET_GLASSFISH}" ]
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User then
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User echo "${OPENGROK_WAR_TARGET_GLASSFISH}"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User return
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User elif [ -n "${OPENGROK_WAR_TARGET}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User echo "${OPENGROK_WAR_TARGET}"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User return
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User fi
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
be6c1c506161e6f45fcff5d0425f78801bc267c1Automatic Updater for prefix in \
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User ${OPENGROK_GLASSFISH_BASE} \
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User /var/appserver
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User do
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User if [ -d "${prefix}/domains" ]
9054d0bb0301aa04ea1ff700ebe4beaf0b573d24Tinderbox User then
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User if [ -z "${domainDirectory}" ]
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User then
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User domainDirectory="${prefix}/domains"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User fi
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User fi
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User done
be6c1c506161e6f45fcff5d0425f78801bc267c1Automatic Updater
be6c1c506161e6f45fcff5d0425f78801bc267c1Automatic Updater if [ -z "${domainDirectory}" ]
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User then
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User return
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User fi
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # User Specified Domain
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User if [ -n "${OPENGROK_GLASSFISH_DOMAIN}" ]
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User then
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User directory="${domainDirectory}/${OPENGROK_GLASSFISH_DOMAIN}/autodeploy"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ ! -d "${directory}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User FatalError "Missing Specified Glassfish Domain " \
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User "${OPENGROK_GLASSFISH_DOMAIN}"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User fi
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User echo "${directory}"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User return
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
a24330c4805a224191ab687d0291963062fe3355Tinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # Arbitrary Domain Selection
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User firstDomain=`ls -1 ${domainDirectory} | head -1`
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -z "${firstDomain}" ]
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User then
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User FatalError "Failed to dynamically determine Glassfish Domain from " \
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User "${domainDirectory}"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User fi
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User echo "${domainDirectory}/${firstDomain}/autodeploy"
1059bc2e42e8214f8b73d3b4cd181d8394a94a6aFrancis Dupont}
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson#
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User# Implementation
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User#
d71e2e0c61df16ff37c9934c371a4a60c08974f7Mark Andrews# The variable "DO" can usefully be set to "echo" to aid in script debugging
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User#
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox UserLoadStandardEnvironment()
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User{
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # Setup a standard execution environment (if required)
f39512a917cdd06c611d366603374f6ef570c80eTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User cronexec="/pkgs/sbin/CronExecutionEnvironment.sh"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User OPENGROK_STANDARD_ENV="${OPENGROK_STANDARD_ENV:-$cronexec}"
00124ad0406365d39f4b2d1011ef6a76706e9df0Mark Andrews
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User if [ -f "${OPENGROK_STANDARD_ENV}" ]
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User then
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User Progress "Loading ${OPENGROK_STANDARD_ENV} ..."
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User . "${OPENGROK_STANDARD_ENV}"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User fi
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User}
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User#
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User# Load default configuration and then merge with user specified configuration.
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User#
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox UserLoadInstanceConfiguration()
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User{
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # Note: As all functions have been defined by the time this routine
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # is called, your configuration can, if desired, override functions
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # in addition to setting the variables mentioned in the function
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # DefaultInstanceConfiguration(), this maybe useful to override
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # functionality used to determine the default deployment environment
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # find dependencies or validate the configuration, for example.
6c8a888822cfe45f0525e7496dcaa27d341b6a5eAutomatic Updater
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User Progress "Loading the default instance configuration ..."
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User DefaultInstanceConfiguration
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User if [ -n "${OPENGROK_CONFIGURATION}" -a -f "${OPENGROK_CONFIGURATION}" ]
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User then
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User # Load the Local OpenGrok Configuration Environment
6c8a888822cfe45f0525e7496dcaa27d341b6a5eAutomatic Updater Progress "Loading ${OPENGROK_CONFIGURATION} ..."
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein . "${OPENGROK_CONFIGURATION}"
90153b6536f7a5078e1c157c980110dbcd7fe205Mark Andrews fi
90153b6536f7a5078e1c157c980110dbcd7fe205Mark Andrews}
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox UserValidateConfiguration()
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User{
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User if [ ! -x "${EXUBERANT_CTAGS}" ]
90153b6536f7a5078e1c157c980110dbcd7fe205Mark Andrews then
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User FatalError "Missing Dependent Application - Exuberant CTags"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User fi
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User if [ ! -d "${SRC_ROOT}" ]
90153b6536f7a5078e1c157c980110dbcd7fe205Mark Andrews then
90153b6536f7a5078e1c157c980110dbcd7fe205Mark Andrews FatalError "OpenGrok Source Path ${SRC_ROOT} doesn't exist"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User fi
90153b6536f7a5078e1c157c980110dbcd7fe205Mark Andrews
90153b6536f7a5078e1c157c980110dbcd7fe205Mark Andrews if [ -n "${QUIET}" -a -n "${VERBOSE}" ]
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User then
0e1dece22e128f9dfa723316a35c4b3f06912381Tinderbox User Warning "Both Quiet and Verbose Mode Enabled - Choosing Verbose"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User QUIET=""
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User VERBOSE="-v"
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User fi
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User
0e1dece22e128f9dfa723316a35c4b3f06912381Tinderbox User if [ -n "${OPENGROK_DERBY}" ]
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User then
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User Warning "CHECK: derbyclient.jar needs to be in where the rest of " \
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User "opengrok used jars are and in unpacked source.war in WEB-INF/lib !"
6bcac4b58d16ee91184a72bd4ff05c41538fd932Tinderbox User fi
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User}
0e1dece22e128f9dfa723316a35c4b3f06912381Tinderbox User
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox UserCreateRuntimeRequirements()
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User{
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User if [ ! -d "${DATA_ROOT}" ]
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User then
8e16b3078757ba3010c24aef805e9e29ed19518bTinderbox User Warning "OpenGrok generated data path ${DATA_ROOT} doesn't exist"
def82e8de9ff45e29ab21e5aba9a39539138c1f4Tinderbox User Progress " Attempting to create generated data directory ... "
def82e8de9ff45e29ab21e5aba9a39539138c1f4Tinderbox User ${DO} mkdir -p "${DATA_ROOT}"
def82e8de9ff45e29ab21e5aba9a39539138c1f4Tinderbox User fi
def82e8de9ff45e29ab21e5aba9a39539138c1f4Tinderbox User if [ ! -d "${DATA_ROOT}" ]
def82e8de9ff45e29ab21e5aba9a39539138c1f4Tinderbox User then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein FatalError "OpenGrok data path ${DATA_ROOT} doesn't exist"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ ! -d "${OPENGROK_INSTANCE_BASE}/etc" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User Warning "OpenGrok generated etc path ${OPENGROK_INSTANCE_BASE}/etc " \
def82e8de9ff45e29ab21e5aba9a39539138c1f4Tinderbox User "doesn't exist"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Progress " Attempting to create generated etc directory ... "
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User ${DO} mkdir -p "${OPENGROK_INSTANCE_BASE}/etc"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ ! -d "${OPENGROK_INSTANCE_BASE}/etc" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein FatalError "OpenGrok etc path ${OPENGROK_INSTANCE_BASE}/etc " \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein "doesn't exist"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -n "${LOGGER_CONFIG_PATH}" -a ! -f "${LOGGER_CONFIG_PATH}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Progress " Creating default ${LOGGER_CONFIG_PATH} ... "
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ ! -f "${LOGGER_CONF_SOURCE}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Warning "Can't find distribution logging configuration" \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein "(${LOGGER_CONF_SOURCE}) to install as default" \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein "logging configuration (${LOGGER_CONFIG_PATH})"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein else
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein filename="opengrok%g.%u.log"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fullpath="${OPENGROK_INSTANCE_BASE}/log/opengrok%g.%u.log"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein ${DO} grep -v java.util.logging.FileHandler.pattern \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein "${LOGGER_CONF_SOURCE}" > "${LOGGER_CONFIG_PATH}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein ${DO} grep java.util.logging.FileHandler.pattern \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein "${LOGGER_CONF_SOURCE}" | \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein sed "s|$filename|$fullpath|g" >> "${LOGGER_CONFIG_PATH}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ ! -d ${OPENGROK_INSTANCE_BASE}/log ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein ${DO} mkdir ${OPENGROK_INSTANCE_BASE}/log
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -n "${OPENGROK_DERBY}" ]
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ ! -d "${OPENGROK_INSTANCE_BASE}/derby" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User Warning "OpenGrok generated derby path " \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein "${OPENGROK_INSTANCE_BASE}/derby doesn't exist"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Progress " Attempting to create generated derby directory ... "
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User ${DO} mkdir -p ${OPENGROK_INSTANCE_BASE}/derby
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein}
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox UserStdInvocation()
def82e8de9ff45e29ab21e5aba9a39539138c1f4Tinderbox User{
057cafaa3df7be7a6dcca71fbaf8fb498fd83518Mark Andrews ${DO} ${JAVA} ${JAVA_OPTS} ${PROPERTIES} \
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User ${LOGGER_PROPERTIES} \
057cafaa3df7be7a6dcca71fbaf8fb498fd83518Mark Andrews ${JAVA_DEBUG} \
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User -jar ${OPENGROK_JAR} \
057cafaa3df7be7a6dcca71fbaf8fb498fd83518Mark Andrews ${IGNORE_PATTERNS} ${ENABLE_PROJECTS} \
057cafaa3df7be7a6dcca71fbaf8fb498fd83518Mark Andrews ${DERBY_HISTORY_CACHE} \
057cafaa3df7be7a6dcca71fbaf8fb498fd83518Mark Andrews ${SCAN_FOR_REPOSITORY} ${REMOTE_REPOSITORIES} \
057cafaa3df7be7a6dcca71fbaf8fb498fd83518Mark Andrews ${SCAN_DEPTH} \
057cafaa3df7be7a6dcca71fbaf8fb498fd83518Mark Andrews ${VERBOSE} ${QUIET} \
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User ${PROGRESS} \
057cafaa3df7be7a6dcca71fbaf8fb498fd83518Mark Andrews ${EXUBERANT_CTAGS:+-c} ${EXUBERANT_CTAGS} \
057cafaa3df7be7a6dcca71fbaf8fb498fd83518Mark Andrews ${MAX_INDEXED_WORDS} ${SKIN} ${LEADING_WILDCARD} \
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User ${READ_XML_CONF} \
def82e8de9ff45e29ab21e5aba9a39539138c1f4Tinderbox User -W ${XML_CONFIGURATION} \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein ${WEBAPP_CONFIG} \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein -s ${SRC_ROOT} -d ${DATA_ROOT} \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein "${@}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein}
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox UserUpdateGeneratedData()
def82e8de9ff45e29ab21e5aba9a39539138c1f4Tinderbox User{
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein StdInvocation -H
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein}
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinUpdateDescriptionCache()
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein{
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # OPTIONAL : Update the EftarFile data
3afd0ff6628df1e7e20161e4afa99469a1195a5bTinderbox User
def82e8de9ff45e29ab21e5aba9a39539138c1f4Tinderbox User if [ -n "${PATH_DESC}" -a -s "${PATH_DESC}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein ${DO} ${JAVA} -classpath ${OPENGROK_JAR} \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein ${EFTAR_UPDATE} ${PATH_DESC} ${EFTAR_OUTPUT_FILE}
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein}
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
OpenGrokUsage()
{
echo "Options for opengrok.jar:" 1>&2
${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 -p "${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
}
DerbyServer()
{
case "${OS_NAME}:${OS_VERSION}" in
SunOS:5.10) Error "unsupported OS" ;;
SunOS:5.11)
/sbin/svcadm enable javadb
;;
Linux:*)
mkdir -p $DATA_ROOT/derby
java -Dderby.system.home=$DATA_ROOT/derby \
-jar /usr/lib/jvm/java-6-sun/db/lib/derbynet.jar start
;;
*) Error "unsupported OS" ;;
esac
}
#
# Main Program
#
if [ $# -eq 0 -o $# -gt 2 ]
then
Usage
fi
LoadStandardEnvironment
LoadInstanceConfiguration
case "${1}" in
deploy)
DeployWar
;;
derby)
ValidateConfiguration
CreateRuntimeRequirements
DerbyServer
;;
update)
ValidateConfiguration
CreateRuntimeRequirements
UpdateGeneratedData
UpdateDescriptionCache
;;
updateQuietly)
ValidateConfiguration
CreateRuntimeRequirements
QUIET="-q"
VERBOSE=""
UpdateGeneratedData
UpdateDescriptionCache
;;
index)
if [ -n "${2}" ]
then
SRC_ROOT="${2}"
fi
ValidateConfiguration
CreateRuntimeRequirements
UpdateGeneratedData
UpdateDescriptionCache
;;
usage)
OpenGrokUsage
Usage
;;
*)
Usage
;;
esac