root/greenstone3/trunk/gs3-setup.sh @ 20233

Revision 20233, 6.6 KB (checked in by oranfry, 11 years ago)

* build.xml: fail if user tries to combine tomcat6 and java1.4
* gs3-setup.sh: if search4j not present, warn they may need java 1.5

  • Property svn:executable set to *
  • Property svn:keywords set to Author Date Id Revision
Line 
1# if this file is executed, /bin/sh is used, as we don't start with #!
2# this should work under ash, bash, zsh, ksh, sh style shells.
3
4#the purpose of this file is to check/set up the environment for greenstone3
5#sorts out:
6#  - gsdl3home
7#  - java
8
9# java_min_version gets passed to search4j as the minimum java version
10java_min_version=1.5.0_00
11
12
13function testSource(){
14
15  if test "$0" != "`echo $0 | sed s/gs3-setup\.sh//`" ; then
16  # if $0 contains "gs3-setup.sh" we've been run... $0 is shellname if sourced.
17  # One exception is zsh has an option to set it temporarily to the script name
18    if test -z "$ZSH_NAME" ; then
19    # we aren't using zsh
20     gsdl_not_sourced=true
21   fi
22  fi
23
24  if test -n "$gsdl_not_sourced" ; then
25     echo "  Error: Make sure you source this script, not execute it. Eg:"
26     echo "    $ source gs3-setup.sh"
27     echo "  or"
28     echo "    $ . gs3-setup.sh"
29     echo "  not"
30     echo "    $ ./gs3-setup.sh"
31     unset gsdl_not_sourced
32     exit 1
33  fi
34
35  if test ! -f gs3-setup.sh ; then
36    echo "You must source the script from within the Greenstone home directory"
37    return 1
38  fi
39  return 0
40}
41
42# if GSDL3SRCHOME is set, then we assume that we have already sourced the
43# script so don't do it again. UNLESS, GSDL3SRCHOME doesn't match the
44# current directory in which case it was a different gs3 installation, so lets
45# do it now.x
46function testAlreadySourced() {
47  if [ ! -z "$GSDL3SRCHOME" ]; then
48    localgs3sourcehome="`pwd`"
49    if [ "$GSDL3SRCHOME" == "$localgs3sourcehome" ]; then
50    echo "Your environment is already set up for Greenstone3"
51    return 1
52    fi
53    echo "Your environment was set up for Greenstone 3 in $GSDL3SRCHOME."
54    echo "Overwriting that set up for the current Greenstone 3 in $localgs3sourcehome"
55  fi
56  return 0
57}
58
59function setGS3ENV() {
60
61  echo "Setting up your environment for Greenstone3"
62  ## main greenstone environment variables ##
63  GSDL3SRCHOME="`pwd`"
64  GSDL3HOME="$GSDL3SRCHOME/web"
65  export GSDL3HOME
66  export GSDL3SRCHOME
67
68  GSDLOS=`uname -s | tr 'ABCDEFGHIJKLMNOPQRSTUVWXYZ' 'abcdefghijklmnopqrstuvwxyz'`
69  # check for running bash under cygwin
70  if test "`echo $GSDLOS | sed 's/cygwin//'`" != "$GSDLOS" ; then
71    GSDLOS=windows
72  fi
73  export GSDLOS
74  echo "  - Exported GSDL3HOME, GSDL3SRCHOME and GSDLOS"
75
76  #change this if external tomcat
77  TOMCAT_HOME="$GSDL3SRCHOME/packages/tomcat"
78
79
80  ## adjustments to users (existing) environment ##
81
82  #PATH
83  addtopath PATH "$GSDL3SRCHOME/bin/script"
84  addtopath PATH "$GSDL3SRCHOME/bin"
85  echo "  - Adjusted PATH"
86
87  #MANPATH
88  addtopath MANPATH "$GSDL3SRCHOME/doc/man"
89  echo "  - Adjusted MANPATH"
90 
91  #CLASSPATH
92  addtopath CLASSPATH "."
93  addtopath CLASSPATH "$GSDL3HOME/WEB-INF/classes"
94  addtopath CLASSPATH "$GSDL3SRCHOME/resources/java"
95  addtopath CLASSPATH "$GSDL3SRCHOME/cp.jar"
96
97  # Tomcat 5 jar files
98  for JARFILE in "$TOMCAT_HOME"/common/endorsed/*.jar; do
99    addtopath CLASSPATH "$JARFILE"
100  done   
101  # Tomcat 6 jar files
102  for JARFILE in "$TOMCAT_HOME"/lib/*.jar; do
103    addtopath CLASSPATH "$JARFILE"
104  done   
105 
106  #shouldn't need these as they will have been copied to their correct locations elsewhere in the greenstone3 installation
107  #for JARFILE in "$GSDL3SRCHOME"/build/*.jar; do
108  #  addtopath CLASSPATH "$JARFILE"
109  #done
110
111  addtopath CLASSPATH "."
112  echo "  - Adjusted CLASSPATH"
113
114  #LD_LIBRARY_PATH
115  addtopath LD_LIBRARY_PATH "$GSDL3SRCHOME/lib/jni"
116  addtopath DYLD_LIBRARY_PATH "$GSDL3SRCHOME/lib/jni"
117  echo "  - Adjusted LD_LIBRARY_PATH and DYLD_LIBRARY_PATH"
118
119  #ant
120  if [ -x "$GSDL3SRCHOME/packages/ant/bin/ant" ]; then
121    ANT_HOME="$GSDL3SRCHOME/packages/ant"
122    export ANT_HOME
123    addtopath PATH "$ANT_HOME/bin"
124    echo "  - Setup Greenstone ant ($GSDL3SRCHOME/packages/ant)"
125  else
126    which ant &> /dev/null
127    if [ "$?" == "0" ]; then
128      echo "  - WARNING: Greenstone 'Ant' package missing - falling back to system Ant"
129      echo "             Note that Greenstone requires Ant 1.7.1 or greater"
130    else
131      echo "  - ERROR: Greenstone 'Ant' package missing - please install Ant yourself"
132      echo "           Note that Greenstone requires Ant 1.7.1 or greater"
133    fi
134
135  fi
136
137}
138
139function checkJava() {
140
141  HINT="`pwd`/packages/jre"
142  if [ $GSDLOS = darwin ]; then
143        HINT=/System/Library/Frameworks/JavaVM.framework/Home
144  fi
145
146  #if search4j is present, use it
147  if [ -x bin/search4j ] ; then
148    FOUNDJAVAHOME="`bin/search4j -p \"$HINT\" -m $java_min_version`"
149    if [ "$?" == "0" ]; then
150      #found a suitible java
151      setupJavaAt "$FOUNDJAVAHOME"
152    else
153      #no suitable java exists
154      echo "  - ERROR: Failed to locate java $java_min_version or greater"
155      echo "           Please set JAVA_HOME or JRE_HOME to point to an appropriate java"
156      echo "           And add JAVA_HOME/bin or JRE_HOME/bin to your PATH"
157    fi
158
159  #otherwise manually try the hint
160  elif [ -d "$HINT" ]; then
161      #found a suitible java
162      setupJavaAt "$HINT"
163
164  #lastly, check if java already setup
165  elif [ "$JAVA_HOME" != "" ] && [ "`which java`" == "$JAVA_HOME/bin/java" ]; then
166    echo "  - Using java at $JAVA_HOME"
167    echo "  - WARNING: Greenstone has not checked the version number of this java installation"
168    echo "             The source distribution of Greenstone3 requires java 1.5 or greater"
169    echo "             (SVN users may still use java 1.4)"
170  elif [ "$JRE_HOME" != "" ] && [ "`which java`" == "$JRE_HOME/bin/java" ]; then
171    echo "  - Using java at $JRE_HOME"
172    echo "  - WARNING: Greenstone has not checked the version number of this java installation"
173    echo "             The source distribution of Greenstone3 requires java 1.5 or greater"
174    echo "             (SVN users may still use java 1.4)"
175
176  #failing all that, print a warning
177  else
178    #no suitable java exists
179    echo "  - ERROR: Failed to locate java"
180    echo "           Please set JAVA_HOME or JRE_HOME to point to an appropriate java"
181    echo "           And add JAVA_HOME/bin or JRE_HOME/bin to your PATH"
182  fi
183}
184
185function setupJavaAt() {
186  export JAVA_HOME="$1"
187  addtopath PATH "$JAVA_HOME/bin"
188  echo "  - Exported JAVA_HOME to $JAVA_HOME"
189}
190
191function pauseAndExit(){
192 echo -n "Please press any key to continue... "
193 read
194}
195
196function isinpath() {
197  for file in `echo $1 | sed 's/:/ /g'`; do
198    if [ "$file" == "$2" ]; then
199      echo true
200      return
201    fi
202  done
203  echo false
204}
205
206function addtopath() {
207  eval "PV=\$$1"
208  #echo "$1 += $2"
209  if [ "$PV" == "" ]; then
210    cmd="$1=\"$2\""
211  else
212    cmd="$1=\"$2:\$$1\""
213  fi
214  eval $cmd
215  eval "export $1"
216}
217
218# Note: use return not exit from a sourced script otherwise it kills the shell
219echo
220testSource
221if [ "$?" == "1" ]; then
222return
223fi
224testAlreadySourced
225if [ "$?" == "1" ]; then
226return
227fi
228setGS3ENV
229checkJava
Note: See TracBrowser for help on using the browser.