OpenGrok revision 1338
1056N/A# OpenGrok Wrapper (initial setup and cron job updating) 1276N/A# Supported Operating Systems: 1056N/A# Supported Deployment Engines: 1056N/A# Supported Environment Variables: 1056N/A# - OPENGROK_NON_INTERACTIVE Suppress Progress and Warnings Messages (*) 1276N/A# - OPENGROK_STANDARD_ENV Run Time Shell Environment (Shell Script) 1056N/A# - OPENGROK_CONFIGURATION User Configuration (Shell Script) 1056N/A# Supported Environment Variables for configuring the default setup: 1056N/A# - OPENGROK_DISTRIBUTION_BASE Base Directory of the OpenGrok Distribution 1056N/A# - OPENGROK_INSTANCE_BASE Base Directory of the OpenGrok User Data Area 1056N/A# - EXUBERANT_CTAGS Full Path to Exuberant CTags 1056N/A# - JAVA_HOME Full Path to Java Installation Root 1056N/A# - OPENGROK_APP_SERVER Application Server ("Tomcat" or "Glassfish") 1056N/A# - OPENGROK_WAR_TARGET_TOMCAT Tomcat Specific WAR Target Directory 1056N/A# - OPENGROK_WAR_TARGET_GLASSFISH Glassfish Specific WAR Target Directory 1056N/A# - OPENGROK_WAR_TARGET Fallback WAR Target Directory 1056N/A# - OPENGROK_TOMCAT_BASE Base Directory for Tomcat (contains webapps) 1056N/A# - OPENGROK_GLASSFISH_BASE Base Directory for Glassfish 1056N/A# - OPENGROK_GLASSFISH_DOMAIN Preferred Glassfish Domain Name 1056N/A# - OPENGROK_PROGRESS Shows progress in %(percentage) of working 1056N/A# through project, it's good to have Verbose 1056N/A# Mode enabled too, cost of this is one more 1056N/A# traversal of the project before indexing it(*) 1056N/A# - OPENGROK_REMOTE_REPOS Disable History Cache for (remote) 1056N/A# - OPENGROK_SCAN_REPOS Disable Scan for repositories (*) 1056N/A# - OPENGROK_SCAN_DEPTH how deep should scanning for repos go 1056N/A# (by default 3 directories from SRC_ROOT) 1056N/A# - OPENGROK_WEBAPP_CFGADDR Web app address to send configuration to 1056N/A# (use "none" to avoid sending it to web app) 1056N/A# - OPENGROK_WPREFIX Disable wildcard prefix search query 1056N/A# - OPENGROK_DERBY if set, then indexer tries to use derby as 1056N/A# historycache (see derby command of this 1056N/A# - READ_XML_CONFIGURATION file with read only configuration 1056N/A# - temporary workaround for bug # 327 1056N/A# (*) Any Non-Empty String will enable these options 1056N/A# Copyright (c) 2008, 2012, Oracle and/or its affiliates. All rights reserved. 1056N/A# Print usage to stderr and exit. 1056N/A echo "Usage: ${progname} <deploy|derby|update|updateQuietly|usage>" 1056N/A echo " ${progname} index [<directory>]" 1056N/A echo " Optional environment variables:" 1056N/A echo " OPENGROK_CONFIGURATION - location of your configuration" 1056N/A echo " See the code for more information on configuration options /" \ 1056N/A# TODO: Handle symlinks correctly (especially in ${0}) 1056N/A# Default Instance Configuration 1056N/A # Use the built-in defaults. This section can be copied to its own 1056N/A # file and tailored to your local requirements. Then simply set 1056N/A # this wrapper. It will save you hand editing in your settings 1056N/A # on each new release. A sample cron(1M) entry might look like: 1056N/A # Note: It is not really possible to ever provided defaults for 1056N/A # these values which will run in every UNIX-like environment. 1056N/A # So I have provided a set which are functional for a given 1056N/A # environment on which you can based you own configuration. 1056N/A # This has been updated to support more environment variables and 1056N/A # operating systems, if you have any reasonably generic 1056N/A # improvements please feel free to submit a patch. 1056N/A if [ -z "${OPENGROK_DISTRIBUTION_BASE}" ] 1056N/A if [ -d "${SCRIPT_DIRECTORY}/dist" -a \ 1056N/A # Handle Developer Build Environments 1056N/A # Handle Binary Distributions 1056N/A # (your source code or the root of all repositories) 1056N/A # REQUIRED: OpenGrok Generate Data Root 1056N/A # (for Lucene index and hypertext cross-references) 1056N/A # This area is rebuilt by "update" / "updateQuietly" 1056N/A # OPTIONAL: User Provided Source Path to Description Mapping (Tab Separated Value) 1056N/A # (The user maintained source of the generated EftarFile file) 1056N/A # REQUIRED: XML Configuration 1056N/A # OPTIONAL: read only XML config, if it exists, it will be read 1276N/A if [ -f "${READ_XML_CONFIGURATION}" ] ; then 1056N/A # REQUIRED: Logger Configuration 1056N/A # REQUIRED: Java Archive of OpenGrok (Installation Location) 1056N/A # REQUIRED(deploy): Web Archive of OpenGrok (Distribution Location) 1056N/A # (user building from source code will find this and other key 1056N/A # files in the "dist" directory after the build is completed) 1056N/A # REQUIRED: Java Virtual Machine 1056N/A # DEVELOPMENT: Debug option, if enabled current indexer will listen on the port 8010 until a debugger connects 1056N/A #JAVA_DEBUG="-agentlib:jdwp=transport=dt_socket,server=y,address=8010,suspend=y" 1056N/A # OPTIONAL: Ignore these patterns as names of files or directories 1056N/A #IGNORE_PATTERNS="-i dummy" 1056N/A # OPTIONAL: Enable Projects 1056N/A # (Every directory in SRC_ROOT is considered a separate project) 1056N/A # OPTIONAL: Scanning Options (for Mercurial repositories) 1056N/A if [ -n "${OPENGROK_SCAN_REPOS}" ] 1056N/A # OPTIONAL: Remote Repository Support (CVS or SVN) 1056N/A # (Can be very time demanding, uncomment if needed) 1056N/A if [ -n "${OPENGROK_REMOTE_REPOS}" ] 1056N/A # OPTIONAL: override depth of scanning for repositories 1056N/A if [ -n "${OPENGROK_SCAN_DEPTH}" ] 1056N/A # OPTIONAL: Allow Leading Wildcard Searches 1056N/A if [ -n "${OPENGROK_WPREFIX}" ] 1056N/A # OPTIONAL: Web Site Look & Feel 1056N/A # (Options: default, offwhite and polished. 1056N/A # Note the quoting requirements) 1056N/A # OPTIONAL: Set Maximum Indexed Words Per File 1056N/A # Note, that you might run out of memory, then either increase JVM memory 1056N/A # as noted in JAVA_OPTS, or set this limit(if you don't mind opengrok not 1056N/A # indexing the rest of the file, once the limit is reached) 1056N/A #MAX_INDEXED_WORDS="-m 100000" 1056N/A # OPTIONAL: Configuration Address (host:port) 1056N/A if [ -n "${OPENGROK_WEBAPP_CFGADDR}" ]; then 1056N/A if [ "${OPENGROK_WEBAPP_CFGADDR}" == "none" ]; then 1056N/A if [ -n "${WEBAPP_CONFIG_ADDRESS}" ]; then 1056N/A #JAVA_OPTS="-server -Xmx2048m" 1056N/A # OPTIONAL: Full Path to History Utilities 1056N/A # OPTIONAL: Override Built-in Properties 1056N/A # Assumption: We should not set properties to the empty string 1056N/A # OPTIONAL: Store The History Cache in Java DB (derby), 1056N/A # instead of file system (in gzipped xml files). 1056N/A # - Running Derby Server - Defaults to localhost:1527 1056N/A if [ -n "${OPENGROK_DERBY}" ] 1056N/A # DELIVERED: An update program for EftarFile 1056N/A # Usage: <class> inputFile [inputFile ...] outputFile 1056N/A # EftarFile == An Extremely Fast Tagged Attribute Read-only File System 1056N/A # HARDCODED: Generated EftarFile (See web/*.jsp) 1056N/A # Be Quiet? (set indirectly by command line arguments in the main program) 1056N/A # or alternatively, Be Verbose! 1056N/A if [ -n "${OPENGROK_VERBOSE}" ] 1056N/A if [ -n "${OPENGROK_PROGRESS}" ] 1056N/A# Helper Functions - Logging 1056N/A# In general, non-interactive use like cron jobs and automated 1056N/A# installation environments should not generate unnecessary 1056N/A# progress information or warnings, as usage and configuration 1056N/A# will have generally been debugged prior to automation. 1056N/A if [ -z "${OPENGROK_NON_INTERACTIVE}" ] 1056N/A if [ -z "${OPENGROK_NON_INTERACTIVE}" ] 1056N/A echo "FATAL ERROR: ${@} - Aborting!" 1>&2 1056N/A# Helper Functions - Autodetection of Runtime Environment 1056N/A Error "Unable to determine Exuberant CTags command name" \ 1056N/A "for ${OS_NAME} ${OS_VERSION}" 1056N/A # Verify that this really is Exuberant Ctags 1056N/A Error "Unable to determine Exuberant CTags command name" \ 1056N/A "for ${OS_NAME} ${OS_VERSION}\n(${binary} is not Exuberant CTags)" 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}" # Load default configuration and then merge with user specified configuration. # 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. Progress "Loading the default instance configuration ..." if [ -n "${OPENGROK_CONFIGURATION}" -a -f "${OPENGROK_CONFIGURATION}" ] # Load the Local OpenGrok Configuration Environment Progress "Loading ${OPENGROK_CONFIGURATION} ..." . "${OPENGROK_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 [ -n "${QUIET}" -a -n "${VERBOSE}" ] Warning "Both Quiet and Verbose Mode Enabled - Choosing Verbose" if [ -n "${OPENGROK_DERBY}" ] 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}" ] Warning "Can't find distribution logging configuration" \ "(${LOGGER_CONF_SOURCE}) to install as default" \ "logging configuration (${LOGGER_CONFIG_PATH})" if [ -n "${OPENGROK_DERBY}" ] if [ ! -d "${OPENGROK_INSTANCE_BASE}/derby" ] Warning "OpenGrok generated derby path ${OPENGROK_INSTANCE_BASE}/derby doesn't exist" Progress " Attempting to create generated derby directory ... " # 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 -p "${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}." case "${OS_NAME}:${OS_VERSION}" in *) Error "unsupported OS" ;; if [ $# -
eq 0 -o $# -
gt 2 ]