OpenGrok revision 5baba343b1d32252619db7e6aff0c1c0be67761c
0N/A# OpenGrok Wrapper (initial setup and cron job updating) 0N/A# Supported Operating Systems: 0N/A# - Solaris 11 (SunOS 5.11) 180N/A# - Solaris 12 (SunOS 5.12) 0N/A# Supported Deployment Engines: 0N/A# Supported Environment Variables: 0N/A# - OPENGROK_NON_INTERACTIVE Suppress Progress and Warnings Messages (*) 0N/A# - OPENGROK_STANDARD_ENV Run Time Shell Environment (Shell Script) 0N/A# - OPENGROK_CONFIGURATION User Configuration (Shell Script) 0N/A# Supported Environment Variables for configuring the default setup: 180N/A# - OPENGROK_DISTRIBUTION_BASE Base Directory of the OpenGrok Distribution 180N/A# - OPENGROK_INSTANCE_BASE Base Directory of the OpenGrok User Data Area 180N/A# - EXUBERANT_CTAGS Full Path to Exuberant CTags 0N/A# - OPENGROK_CTAGS_OPTIONS_FILE Full path to file with extra command line 0N/A# options for CTags program (for its --options 5N/A# - JAVA_HOME Full Path to Java Installation Root 338N/A# - JAVA Full Path to java binary (to enable 64bit JDK) 338N/A# - JAVA_OPTS Java options (e.g. for JVM memory increase 338N/A# or enabling server JDK) 338N/A# JAVA_OPTS=-Xmx2048m is the default! 338N/A# - OPENGROK_APP_SERVER Application Server ("Tomcat" or "Glassfish") 338N/A# - OPENGROK_WAR_TARGET_TOMCAT Tomcat Specific WAR Target Directory 338N/A# - OPENGROK_WAR_TARGET_GLASSFISH Glassfish Specific WAR Target Directory 338N/A# - OPENGROK_WAR_TARGET Fallback WAR Target Directory 338N/A# - OPENGROK_TOMCAT_BASE Base Directory for Tomcat (contains webapps) 338N/A# - OPENGROK_GLASSFISH_BASE Base Directory for Glassfish 338N/A# - OPENGROK_GLASSFISH_DOMAIN Preferred Glassfish Domain Name 338N/A# - OPENGROK_PROGRESS Shows progress in %(percentage) of working 338N/A# through project, it's good to have Verbose 338N/A# Mode enabled too, cost of this is one more 338N/A# traversal of the project before indexing it(*) 338N/A# - OPENGROK_REMOTE_REPOS Influence history cache generation for remote 338N/A# repositories. Following values are recognized: 338N/A# on - enabled (default) 338N/A# off - disabled for indexing and UI 338N/A# dirbased - indexing enabled only for repos 338N/A# which can fetch history for 338N/A# uionly - enabled for UI only 338N/A# - OPENGROK_SCAN_REPOS Disable Scan for repositories (*) 338N/A# - OPENGROK_SCAN_DEPTH how deep should scanning for repos go 338N/A# (by default 3 directories from SRC_ROOT) 0N/A# - OPENGROK_WEBAPP_CFGADDR Web app address to send configuration to 8N/A# (use "none" to avoid sending it to web app) 0N/A# - OPENGROK_WEBAPP_CONTEXT Context URL of the OpenGrok webapp 0N/A# (by default /source) 0N/A# - FULL reindex is needed once this is used 0N/A# (old already indexed files won't be refreshed) 0N/A# - OPENGROK_WPREFIX Disable wildcard prefix search query 0N/A# - OPENGROK_DERBY if set, then indexer tries to use derby as 0N/A# historycache (see derby command of this 27N/A# - OPENGROK_DERBY_URL Use specific URL to JavaDB, e.g. 0N/A# "jdbc:derby://localhost:1528/cachedb;create=true" 27N/A# (default port is 1527) 27N/A# - OPENGROK_TAG Enable parsing of revision tags into the History 0N/A# - READ_XML_CONFIGURATION file with read only configuration 0N/A# - temporary workaround for bug # 327 0N/A# - OPENGROK_FLUSH_RAM_BUFFER_SIZE="-m 16" - set RAM buffer size for flushing, 0N/A# default is 16MB per thread, you might try to 0N/A# increase it to 256MB, but do increase JVM to 0N/A# 4/8/16GB ! Lucene defaults to 8 threads. 0N/A# Increase JVM memory as noted using JAVA_OPTS 286N/A# (*) Any Non-Empty String will enable these options 27N/A# Copyright (c) 2008, 2014, Oracle and/or its affiliates. All rights reserved. 27N/A# Print usage to stdout and exit. 311N/A echo "Usage: ${progname} <deploy|derby|update|updateQuietly|usage|help>" 27N/A echo " ${progname} index [<directory>]" 27N/A echo " ${progname} indexpart <src_root> <directory1> [..]" 27N/A echo " ${progname} clearHistory [<repository_name>]" 27N/A echo " Optional environment variables:" 27N/A echo " OPENGROK_CONFIGURATION - location of your configuration" 27N/A echo " See the code for more information on configuration options /" \ 27N/A# Runtime Configuration 311N/A echo "Cannot determine operating system version" 27N/A# TODO: Handle symlinks correctly (especially in ${0}) 27N/A# Default Instance Configuration 27N/A # Use the built-in defaults. This section can be copied to its own 27N/A # file and tailored to your local requirements. Then simply set 27N/A # this wrapper. It will save you hand editing in your settings 27N/A # on each new release. A sample cron(1M) entry might look like: 27N/A # Note: It is not really possible to ever provided defaults for 27N/A # these values which will run in every UNIX-like environment. 27N/A # So I have provided a set which are functional for a given 27N/A # environment on which you can based you own configuration. 27N/A # This has been updated to support more environment variables and 27N/A # operating systems, if you have any reasonably generic 27N/A # improvements please feel free to submit a patch. 27N/A if [ -z "${OPENGROK_DISTRIBUTION_BASE}" ] 27N/A if [ -d "${SCRIPT_DIRECTORY}/dist" -a \ 27N/A # Handle Developer Build Environments 613N/A # Handle Binary Distributions 27N/A # (your source code or the root of all repositories) 613N/A # REQUIRED: OpenGrok Generate Data Root 27N/A # (for Lucene index and hypertext cross-references) 27N/A # This area is rebuilt by "update" / "updateQuietly" 613N/A # OPTIONAL: User Provided Source Path to Description Mapping 338N/A # (Tab Separated Value) 27N/A # (The user maintained source of the generated EftarFile file) 27N/A # REQUIRED: XML Configuration 189N/A # OPTIONAL: read only XML config, if it exists, it will be read 27N/A if [ -f "${READ_XML_CONFIGURATION}" ] ; then 613N/A # REQUIRED: Logger Configuration 27N/A if [ -n "${OPENGROK_LOGGER_CONFIG_PATH}" ]; then 27N/A if [ ! -f "${OPENGROK_LOGGER_CONFIG_PATH}" ]; then 142N/A echo "File ${OPENGROK_LOGGER_CONFIG_PATH} does not exist" 27N/A # REQUIRED: Java Archive of OpenGrok (Installation Location) 142N/A # REQUIRED(deploy): Web Archive of OpenGrok (Distribution Location) 27N/A # (user building from source code will find this and other key 27N/A # files in the "dist" directory after the build is completed) 27N/A # OPTIONAL: supply extra command line options to CTags program 27N/A if [ -n "${OPENGROK_CTAGS_OPTIONS_FILE}" ]; then 27N/A # REQUIRED: Java Home 27N/A # REQUIRED: Java Virtual Machine 27N/A # DEVELOPMENT: Debug option, if enabled current indexer will listen on the 27N/A # port 8010 until a debugger connects 27N/A #JAVA_DEBUG="-agentlib:jdwp=transport=dt_socket" 27N/A #JAVA_DEBUG="$JAVA_DEBUG,server=y,address=8010,suspend=y" 27N/A # OPTIONAL: Ignore these patterns as names of files or directories 27N/A #IGNORE_PATTERNS="-i dummy" 27N/A # To ignore skipping just the history cache creation for a particular 27N/A # directory and all of it's subdirectories, touch an empty 27N/A # .opengrok_skip_history file at the root of that directory 27N/A # OPTIONAL: Enable Projects 27N/A # (Every directory in SRC_ROOT is considered a separate project) 27N/A # OPTIONAL: Scanning Options (for Mercurial repositories) 27N/A if [ -n "${OPENGROK_SCAN_REPOS}" ] 189N/A # OPTIONAL: Disable remote repository support (CVS or SVN) [on by default] 189N/A if [ -n "${OPENGROK_REMOTE_REPOS}" ] 142N/A # OPTIONAL: override depth of scanning for repositories 613N/A if [ -n "${OPENGROK_SCAN_DEPTH}" ] 27N/A # OPTIONAL: Allow Leading Wildcard Searches 27N/A if [ -n "${OPENGROK_WPREFIX}" ] 27N/A # OPTIONAL: Web Site Look & Feel 27N/A # (Options: default, offwhite and polished. 0N/A # Note the quoting requirements) 332N/A # OPTIONAL: Configuration Address (host:port) 332N/A if [ -n "${OPENGROK_WEBAPP_CFGADDR}" ]; then 332N/A if [ "${OPENGROK_WEBAPP_CFGADDR}" = "none" ]; then 0N/A if [ -n "${WEBAPP_CONFIG_ADDRESS}" ]; then 27N/A # OPTIONAL: Context URL of the OpenGrok webapp 27N/A # (default is /source) 27N/A if [ -n "${OPENGROK_WEBAPP_CONTEXT}" ]; then 27N/A # OPTIONAL: JVM Options 0N/A # OPTIONAL: Full Path to History Utilities 0N/A # OPTIONAL: Override Built-in Properties 0N/A # Assumption: We should not set properties to the empty string 0N/A # OPTIONAL: Store The History Cache in Java DB (derby), 0N/A # instead of file system (in gzipped xml files). 0N/A # - Running Derby Server - Defaults to localhost:1527 0N/A if [ -n "${OPENGROK_DERBY}" ] 0N/A if [ -n "${OPENGROK_DERBY_URL}" ]; then 0N/A # OPTIONAL: Show revision tags in History view. 0N/A # Turn this off if you want to increase indexing performance a bit 0N/A if [ -n "${OPENGROK_TAG}" ] 0N/A # DELIVERED: An update program for EftarFile 0N/A # Usage: <class> inputFile [inputFile ...] outputFile 0N/A # EftarFile == An Extremely Fast Tagged Attribute Read-only File System 0N/A # HARDCODED: Generated EftarFile (See web/*.jsp) 0N/A # Be Quiet? (set indirectly by command line arguments in the main program) 0N/A # or alternatively, Be Verbose! 0N/A if [ -n "${OPENGROK_VERBOSE}" ] 0N/A if [ -n "${OPENGROK_PROGRESS}" ] 0N/A# Helper Functions - Logging 0N/A# In general, non-interactive use like cron jobs and automated 0N/A# installation environments should not generate unnecessary 0N/A# progress information or warnings, as usage and configuration 0N/A# will have generally been debugged prior to automation. 0N/A if [ -z "${OPENGROK_NON_INTERACTIVE}" ] 0N/A if [ -z "${OPENGROK_NON_INTERACTIVE}" ] 0N/A echo "WARNING: ${@}" 1>&2 0N/A echo "ERROR: ${@}" 1>&2 0N/A echo "FATAL ERROR: ${@} - Aborting!" 0N/A# Helper Functions - Autodetection of Runtime Environment 0N/A # Search for Exuberant ctags intelligently, skipping 0N/A # over other ctags implementations. 0N/A # Verify that this really is Exuberant Ctags. 0N/A Error "Unable to determine Exuberant CTags command name" \ 0N/A "for ${OS_NAME} ${OS_VERSION}" 189N/A case "${OS_NAME}:${OS_VERSION}" in 189N/A if [ -z "${javaHome}" ] 189N/A "for ${OS_NAME} ${OS_VERSION}" 189N/A if [ ! -d "${javaHome}" ] 189N/A # Use this function to determine which environment the deploy the 189N/A # web application function into. Some users (especially 189N/A # developers) will have many deployment environments or will wish 338N/A # to specify directly the application server to deploy to. 189N/A # Either use the environment variable OPENGROK_APP_SERVER or 189N/A # reimplement this function in your configuration file (as 189N/A # specified by OPENGROK_CONFIGURATION) 189N/A if [ -n "${OPENGROK_APP_SERVER}" ] 222N/A echo "${OPENGROK_APP_SERVER}" 222N/A # This implementation favours Tomcat, but needs a lot of work, 189N/A # especially if Glassfish is perferrerd or it is under the control 189N/A # of SMF (Service Management Facility) 0N/A # Maybe a better implementation would be to call Application 0N/A # Server specific WAR Directory and see if they exist. 5N/A 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 " \ 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 custom configuration and then fill remaining stuff with defaults. # 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 [ -n "${QUIET}" -a -n "${VERBOSE}" ] Warning "Both Quiet and Verbose Mode Enabled - Choosing Verbose" if [ -n "${OPENGROK_DERBY}" ] "opengrok used jars are and in unpacked source.war in " \ 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 " \ 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 " \ 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})" "${LOGGER_CONF_SOURCE}" > "${LOGGER_CONFIG_PATH}" "${LOGGER_CONF_SOURCE}" | \ 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 " \ 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}), " \ Progress "running, or wait until it loads the just installed web " \ Progress "OpenGrok should be available on <HOST>:<PORT>/source" Progress " where HOST and PORT are configured in ${applicationServer}." case "${OS_NAME}:${OS_VERSION}" in echo "Below might need your socket permission setup" echo "see JDK1.7_51 release notes" *) Error "unsupported OS" ;; # Clear history index for given project. Progress "Removing history index data for repository ${1}"