OpenGrok revision 872
0N/A# OpenGrok Wrapper (initial setup and cron job updating) 0N/A# Supported Operating Systems: 0N/A# - Solaris 10 (SunOS 5.10) 0N/A# - OpenSolaris (SunOS 5.11) 6983N/A# Supported Deployment Engines 0N/A# Supported Environment Variables : 6983N/A# - OPENGROK_NON_INTERACTIVE Suppress Progress and Warnings Messages 6983N/A# - OPENGROK_STANDARD_ENV Run Time Shell Environment (Shell Script) 6983N/A# - OPENGROK_CONFIGURATION User Configuration (Shell Script) 0N/A# Supported Environment Variables for configuring the default setup 0N/A# - OPENGROK_DISTRIBUTION_BASE Base Directory of the OpenGrok Distribution 0N/A# - OPENGROK_INSTANCE_BASE Base Directory of the OpenGrok User Data Area 0N/A# - EXUBERANT_CTAGS Full Path to Exuberant CTags 0N/A# - JAVA_HOME Full Path to Java Installation Root 4554N/A# - OPENGROK_APP_SERVER Application Server ("Tomcat" or "Glassfish") 7147N/A# - OPENGROK_WAR_TARGET_TOMCAT Tomcat Specific WAR Target Directory 0N/A# - OPENGROK_WAR_TARGET_GLASSFISH Glassfish Specific WAR Target Directory 1182N/A# - OPENGROK_WAR_TARGET Fallback WAR Target Directory 0N/A# - OPENGROK_TOMCAT_BASE Base Directory for Tomcat (contains webapps) 2N/A# - OPENGROK_GLASSFISH_BASE Base Directory for Glassfish (contains domains) 0N/A# - OPENGROK_GLASSFISH_DOMAIN Preferred Glassfish Domain Name 6678N/A# - OPENGROK_REMOTE_REPOS set to some value to enable history cache for remote repositories 0N/A echo "Usage: ${0} <deploy|update|updateQuietly|updateConfiguration|usage>" 1>&2 7147N/A echo " ${0} index [<directory>]" 1>&2 3853N/A echo " Optional environment variables:" 1>&2 7147N/A echo " OPENGROK_CONFIGURATION - location of your configuartion" 1>&2 7147N/A echo " See the code for more information on configuration options / variables" 1>&2 3988N/A# TODO: Handle symlinks correctly (especially in ${0}) 7147N/A# Default Instance Configuration 3988N/A # Use the built-in defaults. This section can be copied to its own 3988N/A # file and tailored to your local requirements. Then simply set 3988N/A # this wrapper. It will save you hand editing in your settings 115N/A # on each new release. A sample cron(1M) entry might look like: 7147N/A # Note: It is not really possible to ever provided defaults for 7147N/A # these values which will run in every UNIX-like environment. 6678N/A # So I have provided a set which are functional for a given 7147N/A # environment on which you can based you own configuration. 3853N/A # This has been updated to support more environment variables and 3853N/A # operating systems, if you have any reasonably generic 3853N/A # improvements please feel free to submit a patch. 115N/A if [ -z "${OPENGROK_DISTRIBUTION_BASE}" ] 115N/A if [ -d "${SCRIPT_DIRECTORY}/dist" -a \ 115N/A # Handle Developer Build Environments 0N/A # Handle Binary Distributions 0N/A # (your source code or the root of all repositories) 0N/A # REQUIRED: OpenGrok Generate Data Root 0N/A # (for Lucene index and hypertext cross-references) 0N/A # This area is rebuilt by "update" / "updateQuietly" 0N/A # OPTIONAL: User Provided Source Path to Description Mapping (Tab Separated Value) 0N/A # (The user maintained source of the generated EftarFile file) 3853N/A # REQUIRED: XML Configuration 3853N/A # TODO: Verify that Logger Configuration is REQUIRED and not OPTIONAL 0N/A # REQUIRED: Logger Configuration 7147N/A # REQUIRED: Java Archive of OpenGrok (Installation Location) 0N/A # REQUIRED(deploy): Web Archive of OpenGrok (Distribution Location) 6208N/A # (user building from source code will find this and other key 6678N/A # files in the "dist" directory after the build is completed) 0N/A # REQUIRED: Java Home 7147N/A # REQUIRED: Java Virtual Machine 0N/A # OPTIONAL: Ignore these patterns as names of files or directories 6678N/A #IGNORE_PATTERNS="-i dummy" 0N/A # OPTIONAL: Enable Projects 3853N/A # (Every directory in SRC_ROOT is considered a separate project) 3853N/A # OPTIONAL: Scanning Options (for Mercurial repositories) 3853N/A # OPTIONAL: Remote Repository Support (CVS or SVN) 3853N/A # (Can be very time demanding, uncomment if needed) 3853N/A #REMOTE_REPOSITORIES="-r on" 3853N/A # OPTIONAL: Allow Leading Wildcard Searches 3853N/A # OPTIONAL: Web Site Look & Feel 3853N/A # (Options: default, offwhite and polished. 3853N/A # Note the quoting requirements) 3853N/A # OPTIONAL: Set Maximum Indexed Words Per File 3853N/A # Note, that you might run out of memory, then either increase JVM memory 3853N/A # as noted in JAVA_OPTS, or set this limit(if you don't mind opengrok not 3853N/A # indexing the rest of the file, once the limit is reached) 3853N/A #MAX_INDEXED_WORDS="-m 100000" 3853N/A # OPTIONAL: Configuration Address (host:port) 3853N/A #JAVA_OPTS="-server -Xmx1024m" 3853N/A # OPTIONAL: Full Path to History Utilities 3853N/A # OPTIONAL: Override Built-in Properties 3853N/A # Assumption: We should not set properties to the empty string 3823N/A # OPTIONAL: Store The History Cache in Java DB (derby), 3988N/A # instead of file system (in gzipped xml files). 3988N/A # - Running Derby Server - Defaults to localhost:1527 3988N/A # DELIVERED: An update program for EftarFile 7147N/A # Usage: <class> inputFile [inputFile ...] outputFile 7147N/A # EftarFile == An Extremely Fast Tagged Attribute Read-only File System 7147N/A # HARDCODED: Generated EftarFile (See web/*.jsp) 7147N/A # Be Quiet? (set indirectly by command line arguments in the main program) 7150N/A # or alternatively, Be Verbose! 3988N/A# Helper Functions - Logging 7147N/A# In general, non-interactive use like cron jobs and automated 7147N/A# installation environments should not generate unnecessary 7147N/A# progress information or warnings, as usage and configuration 3988N/A# will have generally been debugged prior to automation. 6678N/A if [ -z "${OPENGROK_NON_INTERACTIVE}" ] 7147N/A if [ -z "${OPENGROK_NON_INTERACTIVE}" ] 6334N/A echo "FATAL ERROR: ${@} - Aborting!" 1>&2 6334N/A# Helper Functions - Autodetection of Runtime Environment 3988N/A Error "Unable to determine Exuberant CTags command name" \ 7196N/A "for ${OS_NAME} ${OS_VERSION}" Error "Unable to determine Java 6 Home" \ "for ${OS_NAME} ${OS_VERSION}" if [ ! -d "${javaHome}" ] Error "Missing Java Home ${javaHome}" # Use this function to determine which environment the deploy the # web application function into. Some users (especially # developers) will have many deployment environments or will wish # to specify directly the application server to deploy to. # Either use the environment variable OPENGROK_APP_SERVER or # reimplement this function in your configuration file (as # specified by OPENGROK_CONFIGURATION) if [ -n "${OPENGROK_APP_SERVER}" ] echo "${OPENGROK_APP_SERVER}" # This implementation favours Tomcat, but needs a lot of work, # especially if Glassfish is perferrerd or it is under the control # of SMF (Service Management Facility) # Maybe a better implementation would be to call Application # Server specific WAR Directory and see if they exist. if [ -n "${OPENGROK_WAR_TARGET_TOMCAT}" ] echo "${OPENGROK_WAR_TARGET_TOMCAT}" elif [ -n "${OPENGROK_WAR_TARGET}" ] echo "${OPENGROK_WAR_TARGET}" if [ -d "${prefix}/webapps" ] if [ -n "${OPENGROK_WAR_TARGET_GLASSFISH}" ] echo "${OPENGROK_WAR_TARGET_GLASSFISH}" elif [ -n "${OPENGROK_WAR_TARGET}" ] echo "${OPENGROK_WAR_TARGET}" if [ -d "${prefix}/domains" ] if [ -z "${domainDirectory}" ] if [ -z "${domainDirectory}" ] if [ -n "${OPENGROK_GLASSFISH_DOMAIN}" ] directory="${domainDirectory}/${OPENGROK_GLASSFISH_DOMAIN}/autodeploy" if [ ! -d "${directory}" ] FatalError "Missing Specified Glassfish Domain ${OPENGROK_GLASSFISH_DOMAIN}" # Arbitrary Domain Selection if [ -z "${firstDomain}" ] FatalError "Failed to dynamically determine Glassfish Domain from ${domainDirectory}" echo "${domainDirectory}/${firstDomain}/autodeploy" # The variable "DO" can usefully be set to "echo" to aid in script debugging # Setup a standard execution environment (if required) if [ -f "${OPENGROK_STANDARD_ENV}" ] Progress "Loading ${OPENGROK_STANDARD_ENV} ..." . "${OPENGROK_STANDARD_ENV}" # 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}" ] # Load the Local OpenGrok Configuration Environment Progress "Loading ${OPENGROK_CONFIGURATION} ..." . "${OPENGROK_CONFIGURATION}" Progress "Loading the default instance configuration ..." if [ ! -x "${EXUBERANT_CTAGS}" ] FatalError "Missing Dependent Application - Exuberant CTags" if [ ! -d "${SRC_ROOT}" ] FatalError "OpenGrok Source Path ${SRC_ROOT} doesn't exist" if [ ! -d "${DATA_ROOT}" ] Warning "OpenGrok Generated Data Path ${DATA_ROOT} doesn't exist" Progress " Attempting to create generated data directory ... " if [ ! -d "${DATA_ROOT}" ] FatalError "OpenGrok Data Path ${DATA_ROOT} doesn't exist" if [ ! -d "${OPENGROK_INSTANCE_BASE}/etc" ] 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" if [ ! -d "${OPENGROK_INSTANCE_BASE}/etc" ] FatalError "OpenGrok Etc Path ${OPENGROK_INSTANCE_BASE}/etc doesn't exist" if [ -n "${LOGGER_CONFIG_PATH}" -a ! -f "${LOGGER_CONFIG_PATH}" ] Progress " Creating default ${LOGGER_CONFIG_PATH} ... " if [ ! -f "${LOGGER_CONF_SOURCE}" ] FatalError "Can't find distribution logging configuration" "(${LOGGER_CONF_SOURCE}) to install as default" "logging configuration (${LOGGER_CONFIG_PATH})" ${DO} cp "${LOGGER_CONF_SOURCE}" "${LOGGER_CONFIG_PATH}" # TODO: Consider automatically setting the logging directory # to within the instance base directory tree #? -R ${XML_CONFIGURATION} \ # OPTIONAL : Update the EftarFile data if [ -n "${PATH_DESC}" -a -s "${PATH_DESC}" ] case "${applicationServer}" in *) FatalError "Unsupported Application Server ${applicationServer}" ;; FatalError "Unable to determine Deployment Directory for ${applicationServer}" if [ ! -f "${OPENGROK_DIST_WAR}" ] FatalError "Missing Web Application Archive ${OPENGROK_DIST_WAR}" if [ ! -d "${warTarget}" ] FatalError "Missing Deployment Directory ${warTarget}" Progress "Installing ${OPENGROK_DIST_WAR} to ${warTarget} ..." ${DO} cp "${OPENGROK_DIST_WAR}" "${warTarget}/" Progress "Start your application server (${applicationServer}), if it is not already" Progress "running, or wait until it loads the just installed web application." Progress "OpenGrok should be available on <HOST>:<PORT>/source" Progress " where HOST and PORT are configured in ${applicationServer}." if [ $# -
eq 0 -o $# -
gt 2 ]