OpenGrok revision 425278cfacbc73f1e955ab6016f206fc5ed93ccb
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson#!/bin/sh
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein#
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# OpenGrok Wrapper (initial setup and cron job updating)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein#
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson# Supported Operating Systems:
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson# - Solaris 11 (SunOS 5.11)
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson# - Solaris 12 (SunOS 5.12)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - Debian (Linux)
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews#
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews# Supported Deployment Engines:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - Tomcat 7
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews# - Tomcat 6
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews# - Glassfish
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews#
af5073d03288a53b646ec3b807ac25ced64d7879Mark Andrews# Supported Environment Variables:
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson# - OPENGROK_NON_INTERACTIVE Suppress Progress and Warnings Messages (*)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - 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
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - OPENGROK_INSTANCE_BASE Base Directory of the OpenGrok User Data Area
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - EXUBERANT_CTAGS Full Path to Exuberant CTags
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - OPENGROK_CTAGS_OPTIONS_FILE Full path to file with extra command line
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# options for CTags program (for its --options
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# switch), default is DATA_ROOT/etc/ctags.config
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - JAVA_HOME Full Path to Java Installation Root
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - JAVA Full Path to java binary (to enable 64bit JDK)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - JAVA_OPTS Java options (e.g. for JVM memory increase
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# or enabling server JDK)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# JAVA_OPTS=-Xmx2048m is the default!
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)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - 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 (*)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - OPENGROK_PROGRESS Shows progress in %(percentage) of working
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# through project, it's good to have Verbose
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# Mode enabled too, cost of this is one more
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# traversal of the project before indexing it(*)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - OPENGROK_REMOTE_REPOS Influence History Cache for (remote)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# Repositories (*). Following values are
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# recognized:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# on - enabled (default)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# off - disabled for indexing and UI
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# uionly - enabled for UI only
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - 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)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - OPENGROK_WEBAPP_CFGADDR Web app address to send configuration to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# (use "none" to avoid sending it to web app)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - OPENGROK_WEBAPP_CONTEXT Context URL of the OpenGrok webapp
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# (by default /source)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - OPENGROK_WPREFIX Disable wildcard prefix search query
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# 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# - OPENGROK_DERBY_URL Use specific URL to JavaDB, e.g.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# "jdbc:derby://localhost:1528/cachedb;create=true"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# (default port is 1527)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - OPENGROK_TAG Enable parsing of revision tags into the History
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# view
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - READ_XML_CONFIGURATION file with read only configuration
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - temporary workaround for bug # 327
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - OPENGROK_FLUSH_RAM_BUFFER_SIZE="-m 16" - set RAM buffer size for flushing,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# default is 16MB per thread, you might try to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# increase it to 256MB, but do increase JVM to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# 4/8/16GB ! Lucene defaults to 8 threads.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# Increase JVM memory as noted using JAVA_OPTS
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein#
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# Notes:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# (*) Any Non-Empty String will enable these options
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein#
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein#
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# Copyright (c) 2008, 2014, Oracle and/or its affiliates. All rights reserved.
61e1dc26d62c2a0059e3ca7efe2ad0f4a5b8df92Mark Andrews#
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein#
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# Print usage to stdout and exit.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein#
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinUsage()
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein{
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein progname=`basename $0`
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein exec >&2
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo ""
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "Usage: ${progname} <deploy|derby|update|updateQuietly|usage|help>"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo " ${progname} index [<directory>]"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo ""
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo " Optional environment variables:"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo " OPENGROK_CONFIGURATION - location of your configuration"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo " e.g. $ OPENGROK_CONFIGURATION=/var/opengrok/myog.conf ${0} ... "
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo ""
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo " See the code for more information on configuration options /" \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein "variables"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo ""
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein exit 1
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein}
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein#
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# Runtime Configuration
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein#
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinif [ -f "/bin/uname" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinthen
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein OS_NAME="`/bin/uname -s`"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein OS_VERSION="`/bin/uname -r`"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinelse
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein OS_NAME="`/usr/bin/uname -s`"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein OS_VERSION="`/usr/bin/uname -r`"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinfi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# TODO: Handle symlinks correctly (especially in ${0})
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinSCRIPT_DIRECTORY="`dirname ${0}`"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinSCRIPT_DIRECTORY="`cd ${SCRIPT_DIRECTORY}; pwd`"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein#
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# Default Instance Configuration
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein#
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinDefaultInstanceConfiguration()
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein{
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # Use the built-in defaults. This section can be copied to its own
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # file and tailored to your local requirements. Then simply set
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # OPENGROK_CONFIGURATION=/path/to/your/configuration, before using
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # this wrapper. It will save you hand editing in your settings
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # on each new release. A sample cron(1M) entry might look like:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # 15 0 * * * OPENGROK_CONFIGURATION=/pkgs/etc/OpenGrok.sh /pkgs/sbin/OpenGrok updateQuietly
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # Note: It is not really possible to ever provided defaults for
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # these values which will run in every UNIX-like environment.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # So I have provided a set which are functional for a given
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # environment on which you can based you own configuration.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # This has been updated to support more environment variables and
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # operating systems, if you have any reasonably generic
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # improvements please feel free to submit a patch.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein OPENGROK_INSTANCE_BASE="${OPENGROK_INSTANCE_BASE:-/var/opengrok}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein LOGGER_CONFIG_FILE="logging.properties"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -z "${OPENGROK_DISTRIBUTION_BASE}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -d "${SCRIPT_DIRECTORY}/dist" -a \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein -f "${SCRIPT_DIRECTORY}/dist/opengrok.jar" -a \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein -f "${SCRIPT_DIRECTORY}/dist/source.war" \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein ]
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}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein else
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # 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)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # This area is rebuilt by "update" / "updateQuietly"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein DATA_ROOT="${OPENGROK_INSTANCE_BASE}/data"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # OPTIONAL: User Provided Source Path to Description Mapping
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # (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
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # (the configuration used by Web/GUI interfaces)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein XML_CONFIGURATION="${OPENGROK_INSTANCE_BASE}/etc/configuration.xml"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # OPTIONAL: read only XML config, if it exists, it will be read
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein READ_XML_CONFIGURATION="${READ_XML_CONFIGURATION:-}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -f "${READ_XML_CONFIGURATION}" ] ; then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein READ_XML_CONF="-R ${READ_XML_CONFIGURATION}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # REQUIRED: Logger Configuration
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 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)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # (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"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
61e1dc26d62c2a0059e3ca7efe2ad0f4a5b8df92Mark Andrews # REQUIRED: Exuberant CTags (http://ctags.sf.net)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein EXUBERANT_CTAGS="${EXUBERANT_CTAGS:-`FindExuberantCTags`}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # OPTIONAL: supply extra command line options to CTags program
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -n "${OPENGROK_CTAGS_OPTIONS_FILE}" ]; then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein CTAGS_OPTIONS_FILE="${OPENGROK_CTAGS_OPTIONS_FILE}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein elif [ -r "${OPENGROK_INSTANCE_BASE}/etc/ctags.config" ]; then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein CTAGS_OPTIONS_FILE="${OPENGROK_INSTANCE_BASE}/etc/ctags.config"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # REQUIRED: Java Home
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein JAVA_HOME="${JAVA_HOME:-`FindJavaHome`}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 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"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # OPTIONAL: Ignore these patterns as names of files or directories
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein #IGNORE_PATTERNS="-i dummy"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # To ignore skipping just the history cache creation for a particular
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # directory and all of it's subdirectories, touch an empty
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # .opengrok_skip_history file at the root of that directory
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # OPTIONAL: Enable Projects
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # (Every directory in SRC_ROOT is considered a separate project)
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson ENABLE_PROJECTS="-P"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # OPTIONAL: Scanning Options (for Mercurial repositories)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein SCAN_FOR_REPOSITORY="-S"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -n "${OPENGROK_SCAN_REPOS}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein SCAN_FOR_REPOSITORY=""
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # OPTIONAL: Disable remote repository support (CVS or SVN) [on by default]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein REMOTE_REPOSITORIES="-r on"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -n "${OPENGROK_REMOTE_REPOS}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein REMOTE_REPOSITORIES="-r ${OPENGROK_REMOTE_REPOS}"
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}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # OPTIONAL: Allow Leading Wildcard Searches
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # (default: on)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein LEADING_WILDCARD="-a on"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -n "${OPENGROK_WPREFIX}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein LEADING_WILDCARD=""
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # OPTIONAL: Web Site Look & Feel
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # (Options: default, offwhite and polished.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # Note the quoting requirements)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein #SKIN='-L default'
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # OPTIONAL: Configuration Address (host:port)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # (conf/web.xml default is localhost:2424)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein WEBAPP_CONFIG=""
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 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: Context URL of the OpenGrok webapp
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # (default is /source)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein WEBAPP_CONTEXT=""
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -n "${OPENGROK_WEBAPP_CONTEXT}" ]; then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein WEBAPP_CONTEXT="-w ${OPENGROK_WEBAPP_CONTEXT}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # OPTIONAL: JVM Options
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein JAVA_OPTS="${JAVA_OPTS:--Xmx2048m}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # OPTIONAL: Full Path to History Utilities
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein HG="`Which hg`"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein CVS="`Which cvs`"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein SVN="`Which svn`"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein SCCS="`Which sccs`"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein CLEARCASE="`Which cleartool`"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein GIT="`Which git`"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein P4="`Which p4`"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein MTN="`Which mtn`"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein BZR="`Which bzr`"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # OPTIONAL: Override Built-in Properties
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # Assumption: We should not set properties to the empty string
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein PROPERTIES="\
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein${HG:+-Dorg.opensolaris.opengrok.history.Mercurial=$HG} \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein${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} \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein${CLEARCASE:+-Dorg.opensolaris.opengrok.history.ClearCase=$CLEARCASE} \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein${GIT:+-Dorg.opensolaris.opengrok.history.git=$GIT} \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein${P4:+-Dorg.opensolaris.opengrok.history.Perforce=$P4} \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein${MTN:+-Dorg.opensolaris.opengrok.history.Monotone=$MTN} \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein${BZR:+-Dorg.opensolaris.opengrok.history.Bazaar=$BZR} \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # OPTIONAL: Store The History Cache in Java DB (derby),
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # instead of file system (in gzipped xml files).
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein #
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # Requirements:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # - derbyclient.jar - See README.txt for more details
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # - Running Derby Server - Defaults to localhost:1527
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein #
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -n "${OPENGROK_DERBY}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein DERBY_OPTIONS="-D"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -n "${OPENGROK_DERBY_URL}" ]; then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein DERBY_OPTIONS="${DERBY_OPTIONS} -u ${OPENGROK_DERBY_URL}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # OPTIONAL: Show revision tags in History view.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # Turn this off if you want to increase indexing performance a bit
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # (default: off)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -n "${OPENGROK_TAG}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein HISTORY_TAGS="-G"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # DELIVERED: An update program for EftarFile
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # Usage: <class> inputFile [inputFile ...] outputFile
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # EftarFile == An Extremely Fast Tagged Attribute Read-only File System
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein EFTAR_UPDATE="org.opensolaris.opengrok.web.EftarFile"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # HARDCODED: Generated EftarFile (See web/*.jsp)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein EFTAR_OUTPUT_FILE="${DATA_ROOT}/index/dtags.eftar"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # Be Quiet? (set indirectly by command line arguments in the main program)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein #QUIET=""
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # or alternatively, Be Verbose!
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein #VERBOSE="-v"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -n "${OPENGROK_VERBOSE}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein VERBOSE="-v"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein QUIET=""
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -n "${OPENGROK_PROGRESS}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein PROGRESS="-C"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein}
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein#
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# Helper Functions - Logging
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein#
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# In general, non-interactive use like cron jobs and automated
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# installation environments should not generate unnecessary
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# progress information or warnings, as usage and configuration
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# will have generally been debugged prior to automation.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein#
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinProgress()
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein{
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -z "${OPENGROK_NON_INTERACTIVE}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "${@}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein}
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinWarning()
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein{
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -z "${OPENGROK_NON_INTERACTIVE}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "WARNING: ${@}" 1>&2
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein}
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinError()
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein{
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "ERROR: ${@}" 1>&2
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein}
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinFatalError()
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein{
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein exec >&2
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo ""
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "FATAL ERROR: ${@} - Aborting!"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo ""
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein ${DO} exit 2
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein}
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein#
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# Helper Functions - Autodetection of Runtime Environment
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein#
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinWhich()
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein{
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein path="`which ${1} 2>/dev/null`"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson if [ -x "${path}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "${path}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein}
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinLocateBinary() {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein for f in $@
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein do
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein file=`which "$f" 2>/dev/null | grep -v '^no '`
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if test -n "$file" -a -x "$file"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo $file
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein return 0
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein done
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo ""
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein return 1
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein}
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinFindExuberantCTags()
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein{
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein binary=`LocateBinary ctags-exuberant exctags ctags`
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if test $? -eq 1
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Error "Unable to determine Exuberant CTags command name" \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein "for ${OS_NAME} ${OS_VERSION}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein return
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # Verify that this really is Exuberant Ctags
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein $binary --version 2>&1 | grep "Exuberant Ctags" > /dev/null
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if test $? -ne 0
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Error "Unable to determine Exuberant CTags command name" \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein "for ${OS_NAME} ${OS_VERSION}\n(${binary} is not Exuberant CTags)"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein return
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo ${binary}
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein}
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinFindJavaHome()
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein{
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein javaHome=""
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein case "${OS_NAME}:${OS_VERSION}" in
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein SunOS:5.10) javaHome="/usr/jdk/instances/jdk1.7.0" ;;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein SunOS:5.11) javaHome="/usr/jdk/latest" ;;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein SunOS:5.12) javaHome="/usr/jdk/latest" ;;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Linux:*)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -f /etc/alternatives/java ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein javaHome=`ls -l /etc/alternatives/java | cut -f 2 -d \> `
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein javaHome=`dirname $javaHome`
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein javaHome=`dirname $javaHome`
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein ;;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein esac
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -z "${javaHome}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Error "Unable to determine Java 7 Home" \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein "for ${OS_NAME} ${OS_VERSION}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein return
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ ! -d "${javaHome}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Error "Missing Java Home ${javaHome}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein return
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "${javaHome}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein}
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinFindApplicationServerType()
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein{
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # Use this function to determine which environment the deploy the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # web application function into. Some users (especially
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # developers) will have many deployment environments or will wish
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # to specify directly the application server to deploy to.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # Either use the environment variable OPENGROK_APP_SERVER or
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # reimplement this function in your configuration file (as
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # specified by OPENGROK_CONFIGURATION)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -n "${OPENGROK_APP_SERVER}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "${OPENGROK_APP_SERVER}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein return
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # This implementation favours Tomcat, but needs a lot of work,
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson # especially if Glassfish is perferrerd or it is under the control
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # of SMF (Service Management Facility)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # Maybe a better implementation would be to call Application
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # Server specific WAR Directory and see if they exist.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -d "/var/tomcat6/webapps" \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein -o -d "/var/lib/tomcat6/webapps" \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein -o -d "/var/lib/tomcat7/webapps" \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "Tomcat"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein return
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -x "/etc/init.d/appserv" -a -d "/var/appserver/domains" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "Glassfish"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein return
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # Assume Tomcat
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "Tomcat"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein}
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinDetermineWarDirectoryTomcat()
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein{
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -n "${OPENGROK_WAR_TARGET_TOMCAT}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "${OPENGROK_WAR_TARGET_TOMCAT}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein return
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein elif [ -n "${OPENGROK_WAR_TARGET}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "${OPENGROK_WAR_TARGET}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein return
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein for prefix in \
fb84f9014321c5f33c4682de5661b579fcde318fAndreas Gustafsson ${OPENGROK_TOMCAT_BASE} \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein /var/tomcat6 \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein /var/lib/tomcat6 \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein /var/lib/tomcat7
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein do
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -d "${prefix}/webapps" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "${prefix}/webapps"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein return
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein done
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein}
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob AusteinDetermineWarDirectoryGlassfish()
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein{
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -n "${OPENGROK_WAR_TARGET_GLASSFISH}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "${OPENGROK_WAR_TARGET_GLASSFISH}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein return
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein elif [ -n "${OPENGROK_WAR_TARGET}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "${OPENGROK_WAR_TARGET}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein return
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein fi
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein for prefix in \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein ${OPENGROK_GLASSFISH_BASE} \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein /var/appserver
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein do
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -d "${prefix}/domains" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [ -z "${domainDirectory}" ]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 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)
cronexec="/pkgs/sbin/CronExecutionEnvironment.sh"
OPENGROK_STANDARD_ENV="${OPENGROK_STANDARD_ENV:-$cronexec}"
if [ -f "${OPENGROK_STANDARD_ENV}" ]
then
Progress "Loading ${OPENGROK_STANDARD_ENV} ..."
. "${OPENGROK_STANDARD_ENV}"
fi
}
#
# Load custom configuration and then fill remaining stuff with defaults.
#
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}"
fi
Progress "Loading the default instance configuration ..."
DefaultInstanceConfiguration
}
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
if [ -n "${QUIET}" -a -n "${VERBOSE}" ]
then
Warning "Both Quiet and Verbose Mode Enabled - Choosing Verbose"
QUIET=""
VERBOSE="-v"
fi
if [ -n "${OPENGROK_DERBY}" ]
then
if [ `uname -s` == "SunOS" -a -d /opt/SUNWjavadb -a -d /usr/opengrok ];
then
if [ -d "/var/tomcat6" -a \
! -r "/var/tomcat6/webapps/source/WEB-INF/lib/derbyclient.jar" ];
then
FatalError "JavaDB on but no derbyclient.jar under" \
"/var/tomcat6/webapps/source/WEB-INF/lib"
fi
if [ ! -r "/usr/opengrok/lib/derbyclient.jar" ]; then
FatalError "JavaDB on but no derbyclient.jar under" \
"/usr/opengrok/lib"
fi
else
Warning "CHECK: derbyclient.jar needs to be in where the rest of " \
"opengrok used jars are and in unpacked source.war in " \
"WEB-INF/lib !"
fi
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
if [ ! -d "${DATA_ROOT}" ]
then
FatalError "OpenGrok data path ${DATA_ROOT} doesn't exist"
fi
if [ ! -d "${OPENGROK_INSTANCE_BASE}/etc" ]
then
Warning "OpenGrok generated etc path ${OPENGROK_INSTANCE_BASE}/etc " \
"doesn't exist"
Progress " Attempting to create generated etc directory ... "
${DO} mkdir -p "${OPENGROK_INSTANCE_BASE}/etc"
fi
if [ ! -d "${OPENGROK_INSTANCE_BASE}/etc" ]
then
FatalError "OpenGrok etc path ${OPENGROK_INSTANCE_BASE}/etc " \
"doesn't exist"
fi
if [ -n "${LOGGER_CONFIG_PATH}" -a ! -f "${LOGGER_CONFIG_PATH}" ]
then
Progress " Creating default ${LOGGER_CONFIG_PATH} ... "
if [ ! -f "${LOGGER_CONF_SOURCE}" ]
then
Warning "Can't find distribution logging configuration" \
"(${LOGGER_CONF_SOURCE}) to install as default" \
"logging configuration (${LOGGER_CONFIG_PATH})"
else
filename="opengrok%g.%u.log"
fullpath="${OPENGROK_INSTANCE_BASE}/log/opengrok%g.%u.log"
${DO} grep -v java.util.logging.FileHandler.pattern \
"${LOGGER_CONF_SOURCE}" > "${LOGGER_CONFIG_PATH}"
${DO} grep java.util.logging.FileHandler.pattern \
"${LOGGER_CONF_SOURCE}" | \
sed "s|$filename|$fullpath|g" >> "${LOGGER_CONFIG_PATH}"
if [ ! -d ${OPENGROK_INSTANCE_BASE}/log ]
then
${DO} mkdir ${OPENGROK_INSTANCE_BASE}/log
fi
fi
fi
if [ -n "${OPENGROK_DERBY}" ]
then
if [ ! -d "${OPENGROK_INSTANCE_BASE}/derby" ]
then
Warning "OpenGrok generated derby path " \
"${OPENGROK_INSTANCE_BASE}/derby doesn't exist"
Progress " Attempting to create generated derby directory ... "
${DO} mkdir -p ${OPENGROK_INSTANCE_BASE}/derby
fi
fi
}
StdInvocation()
{
${DO} ${JAVA} ${JAVA_OPTS} ${PROPERTIES} \
${LOGGER_PROPERTIES} \
${JAVA_DEBUG} \
-jar ${OPENGROK_JAR} \
${IGNORE_PATTERNS} ${ENABLE_PROJECTS} \
${DERBY_OPTIONS} \
${HISTORY_TAGS} \
${SCAN_FOR_REPOSITORY} ${REMOTE_REPOSITORIES} \
${SCAN_DEPTH} \
${VERBOSE} ${QUIET} \
${PROGRESS} \
${EXUBERANT_CTAGS:+-c} ${EXUBERANT_CTAGS} \
${CTAGS_OPTIONS_FILE:+-o} ${CTAGS_OPTIONS_FILE} \
${OPENGROK_FLUSH_RAM_BUFFER_SIZE} ${SKIN} ${LEADING_WILDCARD} \
${READ_XML_CONF} \
-W ${XML_CONFIGURATION} \
${WEBAPP_CONFIG} \
${WEBAPP_CONTEXT} \
-s ${SRC_ROOT} -d ${DATA_ROOT} \
"${@}"
}
UpdateGeneratedData()
{
StdInvocation -H
}
UpdateDescriptionCache()
{
# OPTIONAL : Update the EftarFile data
if [ -n "${PATH_DESC}" -a -s "${PATH_DESC}" ]
then
${DO} ${JAVA} -classpath ${OPENGROK_JAR} \
${EFTAR_UPDATE} ${PATH_DESC} ${EFTAR_OUTPUT_FILE}
fi
}
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
;;
SunOS:5.12)
echo "Below might need your socket permission setup"
echo "see JDK1.7_51 release notes"
set -x
mkdir -p $DATA_ROOT/derby
java -Dderby.system.home=$DATA_ROOT/derby \
-jar /usr/jdk/instances/jdk1.7.0/db/lib/derbynet.jar start
;;
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|help)
OpenGrokUsage
Usage
;;
*)
Usage
;;
esac