root/main/trunk/greenstone3/build.xml @ 30196

Revision 30196, 143.2 KB (checked in by ak19, 5 years ago)

Fixes to do with networked Derby: port and host number changes propagated from build.props to global.props are now at last picked up by DerbyWrapper?.java by build.xml setting a system property (-Dgsdl3.writablehome), which is then used to force load Global.Properties if it's not loaded yet. It won't be loaded when launching the ant update-userdb cmd which runs ModifyUsersDB.java. Or if running ModifyUsersDB.java, txt2usersDB.java or usersDB2txt from the cmdline.

Line 
1<?xml version="1.0"?>
2<!-- ======================================================================
3     March 2005                                                   
4
5     Greenstone3 build and install script
6                 
7     kjdon                                                               
8     ====================================================================== -->
9<project name="greenstone3" default="usage" basedir=".">
10  <echo>os.name: ${os.name}</echo>
11
12  <!-- ============ classpath =================== -->
13  <path id="project.classpath">
14    <fileset dir="lib/java">
15      <include name="**/*.jar"/>
16    </fileset>
17  </path>
18 
19  <!-- ============ self defined tasks =================== -->
20  <taskdef name="mysetproxy" classname="org.greenstone.anttasks.MySetProxy" classpathref="project.classpath"/>
21  <taskdef name="getuserandpassword" classname="org.greenstone.anttasks.MyGetUserAndPassword" classpathref="project.classpath"/>
22  <taskdef name="rsr" classname="org.greenstone.anttasks.RegexSearchReplace" classpathref="project.classpath"/>
23  <!--<taskdef name="svn" classname="org.tigris.subversion.svnant.SvnTask" classpathref="project.classpath"/>-->
24  <taskdef name="if" classname="ise.antelope.tasks.IfTask" classpathref="project.classpath"/>
25  <taskdef name="for" classname="net.sf.antcontrib.logic.ForTask" classpathref="project.classpath"/>
26  <taskdef name="stringutil" classname="ise.antelope.tasks.StringUtilTask" classpathref="project.classpath"/>
27
28 
29  <!-- ===================== Property Definitions =========================== -->
30 
31  <!--
32
33  Each of the following properties are used in the build script.
34  Values for these properties are set by the first place they are
35  defined, from the following list:
36
37  * Definitions on the "ant" command line (ant -Dfoo=bar compile).
38
39  * Definitions from a "build.properties" file in the top level
40  source directory of this application.
41
42  * Definitions from a "build.properties" file in the user's
43  home directory.
44
45  * Default definitions in this build.xml file.
46
47  You will note below that property values can be composed based on the
48  contents of previously defined properties.  This is a powerful technique
49  that helps you minimize the number of changes required when your development
50  environment is modified.  Note that property composition is allowed within
51  "build.properties" files as well as in the "build.xml" script.
52
53  -->
54
55  <property name="os.linux" value="Linux"/>
56  <property name="os.mac" value="Mac OS X"/>
57  <property name="os.solaris" value="SunOS"/>
58  <property name="os.unix" value="${os.linux},${os.mac},${os.solaris}"/>
59  <property name="os.windows" value="Windows 95,Windows 98,Windows 2000,Windows 2003,Windows XP,Windows NT,Windows ME,Windows Vista,Windows 7,Windows Server 2008,Windows Server 2008 R2"/> <!-- check this!!!-->
60
61  <!-- this is true for linux and macs -->
62  <condition property="current.os.isunix">
63    <os family="unix"/>
64  </condition>
65 
66  <condition property="current.os.isunixnotmac">
67    <and>
68      <os family="unix"/>
69      <not>
70    <os family="mac"/>
71      </not>
72    </and>
73  </condition>
74 
75  <condition property="current.os.ismac">
76    <os family="mac"/>
77  </condition>
78 
79  <condition property="current.os.iswindows">
80    <os family="windows"/>
81  </condition>
82
83  <!-- create build.properties if it has not been created yet -->
84  <if>
85    <bool><not><available file="build.properties"/></not></bool>
86    <copy file="build.properties.in" tofile="build.properties"/>
87  </if>
88
89  <!-- create the packages dir if it has not been created yet -->
90  <mkdir dir="packages"/>
91 
92  <!--the first three properties have to be put on the top to be used by build.properties-->
93  <property name="gs2build.home" value="${basedir}${file.separator}gs2build"/>
94  <property name="src.packages.home" value="${basedir}/src/packages"/>
95  <property name="flax.svn.root" value="http://svn.greenstone.org/flax"/>
96
97  <property name="solr-ext.home" value="${basedir}/ext/solr"/>
98
99  <property file="build.properties"/>
100  <if><bool><available file="${user.home}/build.properties"/></bool>
101    <property file="${user.home}/build.properties"/>
102  </if>
103
104  <!-- now we've read in properties, apply defaults -->
105  <property name="disable.collection.building" value="false"/>
106
107  <!-- get properties from the environment -->
108  <property environment="env"/>
109
110  <!-- get the filesets defining components and executables -->
111  <import file="resources/xml/components.xml"/>
112  <import file="resources/xml/executables.xml"/>
113   
114  <!-- version properties for external packages -->
115  <!-- for Java versions < 1.4, we print out the message that Java is too old.
116    For Java 1.4, we use Tomcat 5.5, for Java5 and higher, we use Tomcat 7.0-->
117  <condition property="tomcat.version" value="apache-tomcat-5.5.25" else="apache-tomcat-7.0.57">
118    <equals arg1="1.4" arg2="${ant.java.version}"/>
119  </condition>
120  <condition property="tomcat.version.major" value="5" else="7">
121    <equals arg1="1.4" arg2="${ant.java.version}"/>
122  </condition>
123  <condition property="privileged.attribute" value="privileged='true'" else="">
124    <equals arg1="7" arg2="${tomcat.version.major}"/>
125  </condition>
126
127  <!-- external access to the GS3 pages or not
128       https://tomcat.apache.org/tomcat-7.0-doc/config/valve.html -->
129  <condition property="allowed.IPs"
130         value=".*"
131         else="(127\.0\.0\.1|::1|0:0:0:0:0:0:0:1)">
132    <matches pattern="^(1|true|yes)$" string="${server.external.access}"/>
133  </condition>
134
135  <property name="axis.zip.version" value="axis-bin-1_4.zip"/>
136  <property name="axis.dir.version" value="axis-1_4"/>
137  <property name="sqlite.targz.version" value="sqlite-autoconf-3070602.tar.gz"/>
138
139  <property name="build.home" value="${basedir}/build"/>
140  <property name="src.home" value="${basedir}/src/java"/>
141
142  <if><bool><istrue value="${gsdl3home.isreadonly}"/></bool>
143    <property name="readonly-packages.home" value="${basedir}/packages"/>
144    <property name="packages.home" value="${gsdl3.writablehome}/packages"/>
145  <else>
146    <property name="packages.home" value="${basedir}/packages"/>
147  </else>
148  </if>
149
150  <!-- this may be set in build.properties, e.g. if you move the web dir to
151       tomcats webapps directory -->
152  <property name="web.home" value="${basedir}/web"/>
153  <property name="web.writablehome" value="${gsdl3.writablehome}"/>
154
155  <!-- jar files needed by applets go here -->
156  <property name="web.applet" value="${web.home}/applet"/>
157
158  <!-- jar files needed by the servlet (and extra ones) go here -->
159  <property name="web.lib" value="${web.home}/WEB-INF/lib"/>
160  <property name="web.writablelib" value="${web.writablehome}/WEB-INF/lib"/>
161  <!-- other files needed by the servlet go here -->
162  <property name="web.classes" value="${web.home}/WEB-INF/classes"/>
163  <property name="web.writableclasses" value="${web.writablehome}/WEB-INF/classes"/>
164
165  <if>
166    <bool><istrue value="${gsdl3home.isreadonly}"/></bool>
167    <echo>Greenstone3 home directory is read-only</echo>
168    <echo>  => Writable area is: ${gsdl3.writablehome}</echo>
169
170    <condition property="gsdl3.writablehome.already-exists">
171      <available file="${gsdl3.writablehome}" type="dir"/>
172    </condition>
173
174    <if>
175      <bool><not><istrue value="${gsdl3.writablehome.already-exists}"/></not></bool>
176
177      <!-- set up writable area -->
178      <echo>No previous Greenstone home writable area detected</echo>
179      <echo>  => Setting up area</echo>
180      <mkdir dir="${gsdl3.writablehome}"/>
181      <mkdir dir="${gsdl3.writablehome}/packages"/>
182      <mkdir dir="${gsdl3.writablehome}/logs"/>
183      <mkdir dir="${gsdl3.writablehome}/ext/solr"/>
184
185      <chmod perm="a+rwx" dir="${gsdl3.writablehome}"/>
186      <chmod perm="a+rwx" dir="${gsdl3.writablehome}/packages"/>
187      <chmod perm="a+rwx" dir="${gsdl3.writablehome}/logs"/>
188      <chmod perm="a+rwx" dir="${gsdl3.writablehome}/ext/solr"/>
189
190      <!-- copy over packages tomcat folder -->
191
192      <if>
193    <bool><istrue value="${current.os.iswindows}"/></bool>
194    <copy todir="${gsdl3.writablehome}/packages/tomcat"
195          preservelastmodified="true"
196          failonerror="true" > 
197      <fileset dir="${readonly-packages.home}/tomcat" includes="**"/> 
198    </copy>
199     
200    <else>
201      <!-- else assume Unix -->
202      <!-- Can't go through the OS-independant <copy> task as it fails to preserve exec permissions -->
203      <echo>Copying to ${gsdl3.writablehome}/packages/tomcat</echo>
204      <exec executable="cp" output="/dev/null" spawn="false">
205            <arg value="-r"/>
206            <arg value="${readonly-packages.home}/tomcat"/>
207            <arg value="${gsdl3.writablehome}/packages/."/>
208      </exec>
209     
210    </else>
211      </if>
212     
213      <echo>  => Copying Greenstone's web/WEB-INF to writable area</echo>
214      <copy todir="${gsdl3.writablehome}/WEB-INF"
215        preservelastmodified="true"
216        failonerror="true" > 
217    <fileset dir="${web.home}/WEB-INF" includes="**"/> 
218      </copy>
219
220      <copy todir="${gsdl3.writablehome}"
221        preservelastmodified="true"
222        failonerror="true" > 
223    <fileset dir="${web.home}" includes="index.html"/> 
224      </copy>
225
226    </if>
227  </if>
228
229
230  <!--- flax: the WordNet home -->
231  <property name="wn.home" value="${web.home}/WEB-INF/classes/flax/WordNet"/>
232
233  <!-- jni libraries and java wrappers go here -->
234  <property name="lib.jni" value="${basedir}/lib/jni"/>
235
236  <!-- other jar files needed for installation (but not runtime) go here -->
237  <property name="lib.java" value="${basedir}/lib/java"/>
238 
239  <property name="javadocs" value="${basedir}/docs/javadoc"/>
240
241  <property name="app.name"      value="greenstone3"/>
242  <property name="app.path"      value="/${app.name}"/>
243
244   <property name="admin.dir"      value="${basedir}/admin"/>
245
246  <!-- defaults - set these on the command line or in build.properties or
247       they will take these default values-->
248  <property name="app.version" value="trunk"/>
249  <property name="branch.path" value="trunk"/>
250  <property name="branch.revision" value="HEAD"/>
251
252  <!--constants -->
253  <property name="svn.root" value="http://svn.greenstone.org"/>
254
255  <!-- catalina home is set to tomcat basedir if already installed, otherwise
256       use greenstone's tomcat -->
257  <condition property="catalina.home" value="${tomcat.installed.path}" else="${packages.home}/tomcat">
258    <and>
259      <isset property="tomcat.installed.path"/>
260      <not>
261    <equals arg1="" arg2="${tomcat.installed.path}"/>
262      </not>
263    </and>
264  </condition>
265 
266
267  <!-- is there a better way to do this?? what about solaris?? -->
268  <condition property="os.bin.dir" value="${cross.os}">
269      <istrue value="${compile.cross}"/>
270  </condition>
271  <condition property="os.bin.dir" value="windows">
272    <os family="windows"/>
273  </condition>
274  <condition property="os.bin.dir" value="darwin">
275    <os family="mac"/>
276  </condition>
277  <condition property="os.bin.dir" value="linux">
278    <and>
279      <os family="unix"/>
280      <not>
281    <os family="mac"/>
282      </not>
283    </and>
284  </condition>
285
286 
287  <condition property="collection.building.disabled">
288    <and>
289      <isset property="disable.collection.building"/>
290      <istrue value="${disable.collection.building}"/>
291    </and>
292  </condition>
293
294  <condition property="collection.building.enabled">
295    <not>
296      <istrue value="${disable.collection.building}"/>
297    </not>
298  </condition>
299 
300  <condition property="collection.building.enabled.windows">
301    <and>
302      <istrue value="${collection.building.enabled}"/>
303      <isset property="current.os.iswindows"/>
304    </and>
305  </condition>
306 
307  <condition property="collection.building.enabled.unix">
308    <and>
309      <istrue value="${collection.building.enabled}"/>
310      <isset property="current.os.isunix"/>
311    </and>
312  </condition>
313
314  <condition property="static.arg" value="LDFLAGS=-static" else=" ">
315    <isset property="compile.static"/>
316  </condition>
317
318  <!-- If building a release then we want to adjust environment variables so that the support library can be seen during compilation -->
319  <if><bool><isset property="use.gnomelib.ext"/></bool>
320    <property name="gnome-lib-dir" value="${basedir}/ext/gnome-lib-minimal/${os.bin.dir}"/>
321
322    <if><bool><isset property="env.CFLAGS"/></bool>
323        <property name="cflags.arg" value="CFLAGS=&quot;-I${gnome-lib-dir}/include ${env.CFLAGS}&quot;"/>
324    <else>
325        <property name="cflags.arg" value="CFLAGS=&quot;-I${gnome-lib-dir}/include&quot;"/>
326    </else>
327    </if>
328
329    <if><bool><isset property="env.CPPFLAGS"/></bool>
330        <property name="cppflags.arg" value="CPPFLAGS=&quot;-I${gnome-lib-dir}/include ${env.CPPFLAGS}&quot;"/>
331    <else>
332        <property name="cppflags.arg" value="CPPFLAGS=&quot;-I${gnome-lib-dir}/include&quot;"/>
333    </else>
334    </if>
335
336    <if><bool><isset property="env.CXXFLAGS"/></bool>
337        <property name="cxxflags.arg" value="CXXFLAGS=&quot;-I${gnome-lib-dir}/include ${env.CXXFLAGS}&quot;"/>
338    <else>
339            <property name="cxxflags.arg" value="CXXFLAGS=&quot;-I${gnome-lib-dir}/include&quot;"/>
340    </else>
341    </if>
342
343    <if><bool><isset property="env.LDFLAGS"/></bool>
344        <property name="ldflags.arg" value="LDFLAGS=&quot;-L${gnome-lib-dir}/lib ${env.LDFLAGS}&quot;"/>
345    <else>
346            <property name="ldflags.arg" value="LDFLAGS=&quot;-L${gnome-lib-dir}/lib&quot;"/>
347    </else>
348    </if>
349
350    <if><bool><isset property="env.PATH"/></bool>
351        <property name="path.arg" value="PATH=&quot;${gnome-lib-dir}/bin:${env.PATH}&quot;"/>
352    <else>
353            <property name="path.arg" value="PATH=&quot;${gnome-lib-dir}/bin&quot;"/>
354    </else>
355    </if>
356
357    <if><bool><isset property="env.PKG_CONFIG_PATH"/></bool>
358        <property name="pcpath.arg" value="PKG_CONFIG_PATH=&quot;${gnome-lib-dir}/lib/pkgconfig:${env.PKG_CONFIG_PATH}&quot;"/>
359    <else>
360            <property name="pcpath.arg" value="PKG_CONFIG_PATH=&quot;${gnome-lib-dir}/lib/pkgconfig&quot;"/>
361    </else>
362    </if>
363
364    <if><bool><equals arg1="${os.bin.dir}" arg2="darwin"/></bool>
365        <if><bool><isset property="env.DYLD_LIBRARY_PATH"/></bool>
366            <property name="ldlpath.arg" value="DYLD_LIBRARY_PATH=&quot;${gnome-lib-dir}/lib:${env.DYLD_LIBRARY_PATH}&quot;"/>
367        <else>
368            <property name="ldlpath.arg" value="DYLD_LIBRARY_PATH=&quot;${gnome-lib-dir}/lib&quot;"/>
369        </else>
370        </if>
371    <else>
372        <if><bool><isset property="env.LD_LIBRARY_PATH"/></bool>
373            <property name="ldlpath.arg" value="LD_LIBRARY_PATH=&quot;${gnome-lib-dir}/lib:${env.LD_LIBRARY_PATH}&quot;"/>
374        <else>
375            <property name="ldlpath.arg" value="LD_LIBRARY_PATH=&quot;${gnome-lib-dir}/lib&quot;"/>
376        </else>
377        </if>
378    </else>
379    </if>
380
381    <else>
382        <if><bool><isset property="env.CFLAGS"/></bool>
383            <property name="cflags.arg" value="CFLAGS=&quot;${env.CFLAGS}&quot;"/>
384            <else>
385            <property name="cflags.arg" value=" "/>
386        </else>
387        </if>
388
389        <if><bool><isset property="env.CPPFLAGS"/></bool>
390                <property name="cppflags.arg" value="CPPFLAGS=&quot;${env.CPPFLAGS}&quot;"/>
391            <else>
392            <property name="cppflags.arg" value=" "/>
393        </else>
394        </if>
395
396        <if><bool><isset property="env.CXXFLAGS"/></bool>
397            <property name="cxxflags.arg" value="CXXFLAGS=&quot;${env.CXXFLAGS}&quot;"/>
398        <else>
399            <property name="cxxflags.arg" value=" "/>
400        </else>
401        </if>
402
403        <if><bool><isset property="env.LDFLAGS"/></bool>
404            <property name="ldflags.arg" value="LDFLAGS=&quot;${env.LDFLAGS}&quot;"/>
405        <else>
406            <property name="ldflags.arg" value=" "/>
407        </else>
408        </if>
409
410        <if><bool><isset property="env.PATH"/></bool>
411            <property name="path.arg" value="PATH=&quot;${env.PATH}&quot;"/>
412        <else>
413            <property name="path.arg" value=" "/>
414        </else>
415        </if>
416
417        <if><bool><isset property="env.PKG_CONFIG_PATH"/></bool>
418            <property name="pcpath.arg" value="PKG_CONFIG_PATH=&quot;${env.PKG_CONFIG_PATH}&quot;"/>
419        <else>
420            <property name="pcpath.arg" value=" "/>
421        </else>
422        </if>
423
424        <if><bool><equals arg1="${os.bin.dir}" arg2="darwin"/></bool>
425            <if><bool><isset property="env.DYLD_LIBRARY_PATH"/></bool>
426                <property name="ldlpath.arg" value="DYLD_LIBRARY_PATH=&quot;${env.DYLD_LIBRARY_PATH}&quot;"/>
427            <else>
428                <property name="ldlpath.arg" value=" "/>
429            </else>
430            </if>
431        <else>
432            <if><bool><isset property="env.LD_LIBRARY_PATH"/></bool>
433                <property name="ldlpath.arg" value="LD_LIBRARY_PATH=&quot;${env.LD_LIBRARY_PATH}&quot;"/>
434            <else>
435                <property name="ldlpath.arg" value=" "/>
436            </else>
437            </if>
438        </else> 
439        </if>
440    </else>
441  </if>
442  <property name="allargs" value="${cflags.arg} ${cxxflags.arg} ${cppflags.arg} ${ldflags.arg} ${path.arg} ${ldlpath.arg} ${pcpath.arg}"/>
443
444  <condition property="opt.cross.build"
445         value="--build=${cross.build}" else=" ">
446    <isset property="cross.build"/>
447  </condition>
448
449
450  <condition property="cross.configure.args"
451         value="--host=${cross.host} ${opt.cross.build} CPP=${cross.host}-cpp CC=${cross.host}-gcc CXX=${cross.host}-g++ LD=${cross.host}-ld AR=${cross.host}-ar RANLIB=${cross.host}-ranlib STRIP=${cross.host}-strip ${cross.configure.extraargs} crossOS=${cross.os}" else=" ">
452    <istrue value="${compile.cross}"/>
453  </condition>
454
455  <!-- if we're told to work with gnome-lib, or if there's a gnome-lib-minimal that the user
456       has placed in gs2build/ext, then compile gs2build after sourcing gnome-lib environment -->
457  <condition property="opt.gnomelibext.arg"
458         value="--enable-gnome-lib-ext" else=" ">
459    <or>
460      <available file="${gs2build.home}/ext/gnome-lib-minimal" type="dir"/>
461      <istrue value="${use.gnomelib.ext}"/>
462      <istrue value="${checkout.gnomelib.ext}"/>
463    </or>
464   </condition>
465
466<!-- if you want to disable wvware, do so here: set the value (not else) field to contain minus-minus-disable-wvware -->
467  <condition property="gs2.opt.args" value="${opt.gnomelibext.arg} " else="--disable-mg --disable-mgpp --disable-accentfold --disable-gdbm --disable-sqlite">
468    <istrue value="${with.jni}"/>
469  </condition>
470  <condition property="gs2.compile.target" value="with-jni" else="without-jni">
471    <istrue value="${with.jni}"/>
472  </condition>
473  <condition property="gs2.install.target" value="install-with-jni" else="install-without-jni">
474    <istrue value="${with.jni}"/>
475  </condition>
476  <condition property="gs2.windows.enablejni" value="1" else="0">
477    <istrue value="${with.jni}"/>
478  </condition>
479  <condition property="gs2.windows.enablemg" value="1" else="0">
480    <istrue value="${with.jni}"/>
481  </condition>
482  <condition property="gs2.windows.enablemgpp" value="1" else="0">
483    <istrue value="${with.jni}"/>
484  </condition>
485  <!-- Should accent folding not also be set here ?? -->
486  <condition property="gs2.windows.usegdbm" value="1" else="0">
487    <istrue value="${with.jni}"/>
488  </condition>
489  <condition property="gs2.windows.usesqlite" value="1" else="0">
490    <istrue value="${with.jni}"/>
491  </condition>
492 
493  <!-- where is search4j tool -->
494  <condition property="search4j.exec" value="bin/search4j.exe" else="bin/search4j">
495    <isset property="current.os.iswindows"/>
496  </condition>
497
498 
499  <!-- ============= Base dirs for each package and component ============ -->
500  <property name="src.gsdl3.home" value="${src.home}/org/greenstone/gsdl3"/>
501  <property name="anttasks.home" value="${src.home}/org/greenstone/anttasks"/>
502  <property name="gli.home" value="${basedir}/gli"/>
503  <property name="javagdbm.home" value="${src.packages.home}/javagdbm"/>
504
505  <condition property="common.src.home" value="${basedir}/common-src" else="${gs2build.home}${file.separator}common-src">
506    <istrue value="${disable.collection.building}"/>
507  </condition>
508 
509  <property name="build.src.home" value="${gs2build.home}/build-src"/>
510  <property name="gdbm.home" value="${common.src.home}/packages/gdbm"/>
511  <property name="mg.home" value="${common.src.home}/indexers/mg"/>
512  <property name="mgpp.home" value="${common.src.home}/indexers/mgpp"/>
513  <property name="lucene.home" value="${common.src.home}/indexers/lucene-gs"/>
514
515  <!--  ==================== Compilation Control Options ==================== -->
516
517  <!--
518
519  These properties control option settings on the Javac compiler when it
520  is invoked using the <javac> task.
521
522  compile.debug        Should compilation include the debug option?
523
524  compile.deprecation  Should compilation include the deprecation option?
525
526  compile.optimize     Should compilation include the optimize option?
527
528  -->
529
530  <property name="compile.debug"       value="true"/>
531  <property name="compile.deprecation" value="true"/>
532  <property name="compile.optimize"    value="true"/>
533  <property name="compile.encoding"    value="UTF8"/>
534  <property name="compile.includeantruntime" value="false"/> <!-- to get rid of annoying 'ant' warning -->
535
536  <!--
537
538  Rather than relying on the CLASSPATH environment variable, Ant includes
539  features that makes it easy to dynamically construct the classpath you
540  need for each compilation.  The example below constructs the compile
541  classpath to include the servlet.jar file, as well as the other components
542  that Tomcat makes available to web applications automatically, plus anything
543  that you explicitly added.
544
545  -->
546 
547  <!-- All elements that Tomcat 5 exposes to applications -->
548  <path id="tomcat5">
549    <pathelement location="${catalina.home}/common/classes"/>
550    <fileset dir="${catalina.home}/common/endorsed">
551      <include name="*.jar"/>
552    </fileset>
553    <fileset dir="${catalina.home}/common/lib">
554      <include name="*.jar"/>
555    </fileset>
556    <!-- seems to be empty, but will leave in just in case some people make use of this to customise their install: -->
557    <pathelement location="${catalina.home}/shared/classes"/>
558    <fileset dir="${catalina.home}/shared/lib">
559      <include name="*.jar"/>
560    </fileset>
561  </path>
562 
563  <!-- All elements that Tomcat 7 exposes to applications -->
564  <path id="tomcat7">
565    <fileset dir="${catalina.home}/lib">
566      <include name="*.jar"/>
567    </fileset>
568  </path>
569 
570  <path id="compile.classpath">
571    <!-- Include all jar files and libraries in our jni lib directory -->
572    <pathelement location="${lib.jni}"/>
573    <fileset dir="${lib.jni}">
574      <include name="*.jar"/>
575    </fileset>
576    <!-- Include all jar files in our web lib directory -->
577    <pathelement location="${web.lib}"/>
578    <fileset dir="${web.lib}">
579      <include name="*.jar"/>
580    </fileset>
581   
582    <pathelement location="${lib.java}"/>
583    <fileset dir="${lib.java}">
584      <include name="*.jar"/>
585    </fileset>
586   
587    <!-- include the jar files from the source packages -->
588    <!-- mg and mgpp get installed into lib/jni but they may not be there yet
589    so we add them in by name -->
590    <!-- *** is there any way to make this optional, based on ${with.jni}? -->
591    <pathelement location="${lib.jni}/mg.jar"/>
592    <pathelement location="${lib.jni}/mgpp.jar"/>
593   
594    <!-- Include all elements that Tomcat exposes to applications -->
595    <path refid="tomcat${tomcat.version.major}"/>
596   
597  </path>
598
599  <path id="local.tomcat.classpath">
600    <!-- explicitly include the jni java wrappers in the classpath -->
601    <pathelement location="${lib.jni}"/>
602    <fileset dir="${lib.jni}">
603      <include name="*.jar"/>
604    </fileset>
605   
606    <pathelement location="${web.writablelib}"/>
607    <fileset dir="${web.writablelib}">
608      <include name="derbyclient.jar"/> <!--<include name="derby.jar"/>-->
609    </fileset>
610  </path>
611 
612  <path id="derby.server.classpath">
613    <pathelement location="${web.lib}/derbynet.jar"/>
614    <pathelement location="${web.lib}/derby.jar"/>
615  </path>
616
617
618  <path id="local.tomcat.path">
619    <pathelement location="${basedir}/bin/script"/>
620    <pathelement location="${basedir}/bin"/>
621    <pathelement location="${lib.jni}"/>
622    <pathelement path="${env.PATH}"/>
623    <pathelement path="${env.Path}"/>
624    <pathelement path="${wn.home}/bin"/>
625  </path>
626
627  <target name="test-setup">
628    <echo>ant java version=${ant.java.version}</echo>
629    <echo>is unix : ${current.os.isunix}</echo>
630    <echo>is mac : ${current.os.ismac}</echo>
631    <echo>is unixnotmac : ${current.os.isunixnotmac}</echo>
632    <echo>is windows : ${current.os.iswindows}</echo>
633    <echo>os.unix: ${os.unix}</echo>
634  </target>
635
636  <!-- Appends the current env to the file environment.txt. For debugging env vars used by the release-kit. -->
637  <target name="write-env" description="Writes out the environment that this build.xml is executed in to file environment.txt. For debugging.">
638    <echo message="*****************ENVIRONMENT OUTPUT:****************${line.separator}" file="environment.txt" append="true" />
639
640    <if><bool><istrue value="${current.os.iswindows}"/></bool>
641      <exec executable="set" dir="${basedir}" failonerror="false" output="environment.txt" append="true">     
642    <arg value="/c" />
643    <arg value="set" />
644      </exec>
645      <else>
646    <exec executable="env" dir="${basedir}" failonerror="false" output="environment.txt" append="true" />
647      </else>
648    </if>
649
650    <echo message="${line.separator}" file="environment.txt" append="true" />
651  </target>
652
653 
654  <!-- ==================== Primary and Global Targets ============================= -->
655
656  <target name="prepare" depends="accept-properties,init,copy-dot-in-files,prepare-core,prepare-packages,prepare-common-src,prepare-collection-building,prepare-tomcat,prepare-axis,prepare-web,prepare-collections, prepare-flax"
657    description="Use this when you first checkout the code: 'ant prepare install'. This will do some additional subversion checkouts and downloads, so you need to be online to run this.">
658
659    <!-- make sure .sh files are executable -->
660    <chmod dir="${basedir}" perm="ugo+rx"
661      includes="*.sh"/>
662    <chmod dir="${basedir}/bin/script" perm="ugo+rx"
663      includes="*.sh,*.pl"/>
664  </target>
665
666  <!-- install-common-src and install-collection-building are mutually exclusive and either one or the other will be done depending on whether collection building is enabled or not -->
667  <!--before configuring build-src, make sure that gnome-lib is compiled up-->
668  <target name="install" depends="init,compile-imagemagick,compile-gnome-lib,install-common-src,install-collection-building,install-runtime,install-solr-ext,setup-for-eclipse,get-isisgdl"
669    description="Install Greenstone 3. Use this when you first checkout the code: 'ant prepare new-install'."/>
670
671  <target name="install-common-src" depends="init"
672    description="Install (configure, compile, install) only the common-src package (shared code from Greenstone 2). " >
673    <antcall target="configure-common-src"/>
674    <antcall target="compile-common-src"/>
675    <antcall target="install-auxiliary-jar-files"/>
676    <antcall target="install-jni-files"/>
677  </target>
678
679  <target name="install-collection-building" depends="init" if="collection.building.enabled"
680    description="Install (configure, compile, install) the Greenstone 2 collection building package." >
681    <antcall target="configure-collection-building"/>
682    <antcall target="tweak-makefiles" />
683    <antcall target="compile-collection-building"/>
684  </target>
685   
686
687  <target name="install-runtime" depends="init,configure,configure-packages,configure-core,compile-web,compile-packages,compile-core,compile-classpath-jars"
688    description="Install (configure, compile, install) the runtime system. Needs either common-src or collection-building to have been installed first." />
689   
690  <target name="svnupdate" depends="init,svnupdate-packages,svnupdate-core,svnupdate-common-src,svnupdate-collection-building,svnupdate-web"
691    description="Do a `svn update` for all sources. Doesn't recompile the code. You need to be online to run this."/>
692 
693  <target name="configure" depends="init,configure-tomcat,configure-web"
694    description="Configure the installation (not the C++ code). Includes setting up config files. Should be re-run if you change the build.properties file, including if you change the port number."/>
695
696  <target name="clean" depends="init,clean-packages,clean-core,clean-common-src,clean-collection-building,clean-classpath-jars"
697    description="Remove all old compiled code. Includes runtime and collection-building if necessary"/>
698 
699  <target name="distclean" depends="init,distclean-packages,clean-core,distclean-common-src,distclean-collection-building,clean-classpath-jars"
700    description="Remove all compiled code and also any Makefiles etc generated during configure-c++. Includes runtime and collection-building as necessary"/>
701 
702  <target name="update" depends="init,svnupdate,clean,install"
703    description="Update (thru Subversion) all the source (including common-src or collection-building, and runtime), then clean, and re-install. To do this without any SVN updates, run it like 'ant -Dnosvn.mode=yes update'"/>
704
705
706  <target name="perl-for-building" depends="init">
707    <!-- uses perl.path if set in build.properties, otherwise try for
708         environment variable PERLPATH, and failing that assumes 'perl'
709         is on environment PATH -->
710    <!-- if, outside build.properties, we only set perl.path if we have gs2build/build-src (collection building), then we won't set perl.path in a (flax) binary, since it doesn't have build-src -->
711    <if><bool><available file="${gs2build.home}"/></bool>
712
713      <if><bool><not><isset property="perl.path"/></not></bool>
714
715        <if>
716          <bool>
717            <and>
718              <isset property="env.PERLPATH"/>
719              <not><equals arg1="${env.PERLPATH}" arg2=""/></not>
720            </and>
721          </bool>
722          <!-- set perlpath to env.PERLPATH.
723            This is the path to perl\bin that's found by findperl.bat when the server is launched
724            through GLI instead of the console.
725            For windows, this env.PERLPATH is the bin folder and needs a backslash at end, since it
726            will appear suffixed with "perl.exe" in the perl setting in packages\tomcat\config\web.xml.
727            This web.xml's path to perl is then used to find perl when running the perl scripts in the
728            cgi folder, so without a slash appended at this point it becomes "binperl" in web.xml, and
729            things will break when GLI launches the server on Windows and the online GS3 metadata editor
730            is used to save user-edited metadata. -->
731          <if><bool><istrue value="${current.os.iswindows}"/></bool>
732            <property name="perl.path" value="${env.PERLPATH}\"/>
733          <else>
734            <property name="perl.path" value="${env.PERLPATH}"/>
735          </else>   
736          </if>
737         
738          <else>
739            <echo>
740  Using PATH environment variable to locate Perl.
741            </echo>
742            <exec executable="which" os="${os.unix}" spawn="false" outputproperty="full.perl.path">
743              <arg value="perl" />
744            </exec>
745
746        <exec executable="${gs2build.home}/bin/windows/which" osfamily="windows" spawn="false" outputproperty="full.perl.path">
747              <arg value="perl" />
748            </exec>
749
750            <stringutil string="${full.perl.path}" property="partial.perl.path">
751                <replace regex="\/[^\/]*$" replacement="/" />
752            </stringutil>
753        <stringutil string="${partial.perl.path}" property="perl.path">
754                <replace regex="\\[^\\]*$" replacement="\\" />
755            </stringutil>
756            <if><bool><istrue value="${current.os.isunix}"/></bool>
757              <if><bool><not><equals arg1="${full.perl.path}" arg2="/usr/bin/perl"/></not></bool>
758                <echo>
759    Non-standard location of Perl found: ${full.perl.path}
760    Set the environment variable PERLPATH or the perl.path property in
761    build.properties to explicitly control the version of Perl used.
762                </echo>
763              </if>
764            </if>
765          </else>
766        </if>
767      </if>
768
769      <!-- full.perl.path is for pretty-printing only, e.g. used in target "start" -->
770      <if><bool><isset property="perl.path"/></bool>
771        <property name="full.perl.path" value="${perl.path}${file.separator}perl"/>
772        <else>
773          <property name="full.perl.path" value="perl (will use the enviroment variable PATH to find this executable)"/>
774        </else>
775      </if>
776
777      <!-- gs2build not available, perl.path -->
778      <else>
779    <property name="perl.path" value=""/>
780      </else>
781    </if>
782    <stringutil string="${perl.path}" property="escaped.perl.path">
783      <replace regex="\\" replacement="\\\\" />
784    </stringutil>
785  </target>
786
787  <target name="get-default-servlet-url">
788    <echo>http://${tomcat.server}:${tomcat.port}${app.path}${server.default.servlet}</echo>
789  </target>
790
791  <target name="check-derbyserver-running">
792    <condition property="derby.isrunning" value="true" else="false">
793      <!--<socket server="jdbc:derby://${derby.server}" port="${derby.server.port}"/>-->
794      <socket server="${derby.server}" port="${derby.server.port}"/><!-- like telnet machine port -->
795    </condition>
796    <echo>Derby is running: ${derby.isrunning}</echo>
797  </target>
798
799  <!-- Need a copy of the check-derby-running target with a distinct property, because ant restart runs
800       both stop and start, which stop and start derby respectively. Both  need check the derby socket.
801       Because each property can be set only once during an invocation with ant, ant restart will need
802       two check-derbyserver properties, one for each derby check. -->
803  <target name="check-derbyserver-started">
804    <condition property="derby.isstarted" value="true" else="false">
805      <socket server="${derby.server}" port="${derby.server.port}"/>
806    </condition>
807    <echo>Derby is running: ${derby.isstarted}</echo>
808  </target>
809
810
811  <!-- Unused -->
812  <target name="start-derby-java" depends="check-derbyserver-running">
813    <if><bool><not><istrue value="${derby.isrunning}"/></not></bool>
814      <echo>Launching derby on ${derby.server}:${derby.server.port}...</echo>
815      <java classname="org.apache.derby.drda.NetworkServerControl" fork="true" spawn="true" clonevm="true">     
816    <arg value="start"/>
817    <classpath refid="derby.server.classpath"/>
818      </java>
819      <else>
820    <echo>Derby server ALREADY RUNNING on ${derby.server}:${derby.server.port}</echo>
821      </else>
822    </if>
823  </target>
824 
825  <target name="start-derby" depends="check-derbyserver-started">
826    <if><bool><not><istrue value="${derby.isstarted}"/></not></bool>
827      <echo>About to launch derby on ${derby.server}:${derby.server.port}</echo>
828      <antcall target="force-start-derby"/>
829      <else>
830    <echo>Derby networked server ALREADY RUNNING on ${derby.server}:${derby.server.port}</echo>
831      </else>
832    </if>
833  </target>
834
835  <!-- Using derby 10.1.2.1
836       See db-derby-10.1.2.1-bin/docs/html/adminguide/index.html -->
837  <target name="force-start-derby">
838      <property name="derby.server.classpath.prop" refid="derby.server.classpath" />
839     
840      <exec executable="java" spawn="true"><!-- failonerror="true"-->
841    <env key="CLASSPATH" path="${derby.server.classpath.prop}"/>
842    <arg value="org.apache.derby.drda.NetworkServerControl"/>
843    <arg value="start"/>
844    <arg value="-p"/>
845    <arg value="${derby.server.port}"/>
846      </exec>
847
848  </target>
849
850  <target name="force-stop-derby">
851    <java classname="org.apache.derby.drda.NetworkServerControl">
852      <arg value="shutdown"/>
853      <arg value="-p"/>
854      <arg value="${derby.server.port}"/>
855      <classpath refid="derby.server.classpath"/>
856    </java>
857  </target>
858
859  <target name="stop-derby" description="Shutdown derby server only if running" depends="check-derbyserver-running"><!-- if="${derby.isrunning}" checks if true or false only from ant 1.8 on -->
860    <if><bool><istrue value="${derby.isrunning}"/></bool>
861      <!--<echo>Derby is |${derby.isrunning}| running</echo>-->
862      <antcall target="force-stop-derby"/>
863      <else>
864    <echo>Derby is not running</echo>
865      </else>
866    </if>
867  </target>
868
869  <target name="start" depends="init,configure-tomcat,configure-web,configure-solr-ext,start-derby,start-tomcat"
870    description="Startup the Tomcat server." >
871    <echo>${app.name} (${app.version}) server running using Apache Tomcat and Java</echo>
872    <echo>Tomcat: ${catalina.home}</echo>
873    <echo>Java  : ${java.home}</echo>
874    <if><bool><available file="${build.src.home}"/></bool>
875      <echo>Perl  : ${full.perl.path}</echo>
876    </if>
877    <if><bool><isset property="install.flax"/></bool>
878        <property name="url" value="http://${tomcat.server}:${tomcat.port}${app.path}/flax"/>
879    <else>
880        <property name="url" value="http://${tomcat.server}:${tomcat.port}${app.path}/"/>
881    </else>
882    </if>
883    <echo>URL   : ${url}</echo>
884    <!-- assuming that index.html is not needed here -->   
885
886    <!--Now write out the url with oaiserver suffix as the baseURL property in OAIConfig.xml-->
887    <available file="${basedir}/resources/oai/OAIConfig.xml" property="oaiconfig.present"/>
888    <antcall target="init-oaiconfig">
889      <param name="url" value="${url}"/>
890    </antcall>
891  </target>
892
893  <target name="init-oaiconfig" if="oaiconfig.present">
894    <echo>Writing out baseURL ${url}oaiserver to ${web.writableclasses}/OAIConfig.xml</echo>
895    <copy file="${basedir}/resources/oai/OAIConfig.xml" tofile="${web.writableclasses}/OAIConfig.xml"/>
896    <rsr verbosity="1" file="${web.writableclasses}/OAIConfig.xml" pattern="&lt;baseURL&gt;.*&lt;/baseURL&gt;" replacement="&lt;baseURL&gt;${url}oaiserver&lt;/baseURL&gt;" />   
897  </target>
898
899  <target name="stop" depends="init,stop-tomcat,stop-derby"
900    description="Shutdown the Tomcat server."/>
901 
902  <target name="restart" description="Shutdown and restart Tomcat"  depends="init,stop,start"/>
903
904  <!-- =========== Help targets ===================================  -->
905 
906  <property name="install-command" value="ant [options] prepare install"/>
907 
908  <target name="usage" description="Print a help message">
909    <echo message="  Execute 'ant -projecthelp' for a list of targets."/>
910    <echo message="  Execute 'ant -help' for Ant help."/>
911    <echo>
912  To install Greenstone3, run '${install-command}'.
913    There are properties defined in build.properties. The install
914      process will ask you if these properties are set correctly.
915      To avoid this prompt, use the '-Dproperties.accepted=yes'
916      option.
917    To log the output, use the '-logfile build.log' option.
918  The README.txt file has more information about the ant targets
919    and install process.
920    </echo>
921  </target>
922 
923  <target name="help" depends="usage" description="Print a help message"/>
924 
925  <target name="debug" depends="init" description="Display all the currently used properties">
926    <echoproperties/>
927  </target>
928
929  <!-- ====== initialization and setup targets ================== -->
930
931  <target name="accept-properties" unless="properties.accepted">
932    <input addproperty="properties.ok" validargs="y,n">The following properties (among others) are being used from a build.properties file found in this directory:
933      tomcat.server=${tomcat.server}
934      tomcat.port=${tomcat.port}
935      tomcat.installed.path=${tomcat.installed.path} (this is the location of Tomcat's base dir if it is already installed)
936      proxy.host=${proxy.host}
937      proxy.port=${proxy.port}
938      disable.collection.building=${disable.collection.building}
939      If these are not acceptable, please change them and rerun this target. Continue [y/n]?
940    </input>
941    <condition property="do.abort">
942      <equals arg1="n" arg2="${properties.ok}"/>
943    </condition>
944    <fail if="do.abort">Build aborted by user. Please change your properties settings and re-run the target</fail>
945  </target>
946 
947  <!-- this sets up some initial properties -->
948  <target name="init">
949
950    <!-- has the gs3-setup script been run?? -->
951    <condition property="gs3-setup-not-done">
952      <not>
953    <isset property="env.GSDL3HOME"/>
954      </not>
955    </condition>
956
957    <!--<fail if="gs3-setup-not-done" message="please run 'gs3-setup' (Windows) or 'source gs3-setup.sh' (Linux/Mac) before running this target."/>-->
958   
959    <condition property="java.too.old">
960      <or>
961        <equals arg1="1.1" arg2="${ant.java.version}"/>
962        <equals arg1="1.2" arg2="${ant.java.version}"/>
963        <equals arg1="1.3" arg2="${ant.java.version}"/>
964      </or>
965    </condition>
966    <fail if="java.too.old" message="You need Java 1.4 or greater to run Greenstone 3"/>
967   
968    <available file="${basedir}/gli" property="gli.present"/>
969    <available file="${basedir}/common-src" property="common.src.present"/>
970    <available file="${basedir}/gs2build" property="gs2build.present"/>
971    <available file="${gnome-lib-dir}" property="gnome-lib.present"/>
972
973    <condition property="tomcat.islocal">
974      <or>
975        <not><isset property="tomcat.installed.path"/></not>
976        <equals arg1="" arg2="${tomcat.installed.path}"/>
977      </or>
978    </condition>
979   
980    <echo>tomcat.port = ${tomcat.port}</echo>
981
982    <condition property="proxy.present">
983      <and>
984        <isset property="proxy.host"/>
985        <not><equals arg1="" arg2="${proxy.host}"/></not>
986      </and>
987    </condition>
988
989    <!--
990    the next block checks if the bundled tomcat is present in the 'packages' directory,
991    and checks for the lethal combination of tomcat 7 and java 1.4. Test for
992    tomcat6 is based on the presence of a file inserted by greenstone into the tomcat6
993    download, as there is no other surefire way to check tomcat version under java 1.4
994    -->
995    <condition property="packages.tomcat.ispresent" value="true" else="false">
996      <available file="packages/tomcat"/>
997    </condition>
998    <condition property="packages.tomcat.istomcat7" value="true" else="false">
999      <available file="packages/tomcat/tomcat7.txt"/>
1000    </condition>
1001    <if>
1002      <bool>
1003        <and>
1004          <istrue value="${packages.tomcat.ispresent}"/>
1005          <istrue value="${packages.tomcat.istomcat7}"/>
1006          <equals arg1="1.4" arg2="${ant.java.version}"/>
1007        </and>
1008      </bool>
1009      <fail>Your Java (version 1.4) is too old to work with the bundled Apache Tomcat (version 6). Please upgrade to Java version 1.5 or greater. Alternatively, you may remove the bundled Apache Tomcat from the 'packages' folder and then run 'ant prepare-tomcat'.</fail>
1010    </if>
1011
1012  </target>
1013
1014  <target name="setup-proxy" depends="init" if="proxy.present">
1015    <condition property="ask.user">
1016      <or>
1017        <equals arg1="" arg2="${proxy.user}"/>
1018        <equals arg1="" arg2="${proxy.password}"/>
1019      </or>
1020    </condition>
1021   
1022    <getuserandpassword message="Using proxy: ${proxy.host}:${proxy.port}" if="ask.user" username="${proxy.user}" userproperty="proxy.username" pwordproperty="proxy.password"/>
1023    <mysetproxy proxyhost="${proxy.host}" proxyport="${proxy.port}" proxyuser="${proxy.username}" proxypassword="${proxy.password}"/>
1024  </target>
1025 
1026  <target name="copy-dot-in-files" depends="init"
1027      description="Copies all resources .in files to version without the .in suffix" >
1028    <if><bool><available file="${basedir}/resources/tomcat/greenstone3.xml"/></bool>
1029      <copy file="${basedir}/resources/tomcat/greenstone3.xml" tofile="${basedir}/resources/tomcat/greenstone3.xml.backup"  overwrite="true"/>
1030    </if>
1031   
1032    <copy file="${basedir}/resources/tomcat/greenstone3.xml.in" tofile="${basedir}/resources/tomcat/greenstone3.xml"  overwrite="true"/>
1033    <if><bool><available file="${basedir}/resources/tomcat/server_tomcat5.xml"/></bool>
1034      <copy file="${basedir}/resources/tomcat/server_tomcat5.xml" tofile="${basedir}/resources/tomcat/server_tomcat5.xml.backup"  overwrite="true"/>
1035    </if>
1036    <copy file="${basedir}/resources/tomcat/server_tomcat5.xml.in" tofile="${basedir}/resources/tomcat/server_tomcat5.xml"  overwrite="true"/>
1037    <if><bool><available file="${basedir}/resources/tomcat/server_tomcat7.xml"/></bool>
1038      <copy file="${basedir}/resources/tomcat/server_tomcat7.xml" tofile="${basedir}/resources/tomcat/server_tomcat7.xml.backup"  overwrite="true"/>
1039    </if>
1040    <copy file="${basedir}/resources/tomcat/server_tomcat7.xml.in" tofile="${basedir}/resources/tomcat/server_tomcat7.xml" overwrite="true"/>
1041    <if><bool><available file="${basedir}/resources/tomcat/web.xml"/></bool>
1042      <copy file="${basedir}/resources/tomcat/web.xml" tofile="${basedir}/resources/tomcat/web.xml.backup"  overwrite="true"/>
1043    </if>
1044    <copy file="${basedir}/resources/tomcat/web.xml.in" tofile="${basedir}/resources/tomcat/web.xml"  overwrite="true"/>
1045    <if><bool><available file="${basedir}/resources/oai/OAIConfig.xml"/></bool>
1046    <copy file="${basedir}/resources/oai/OAIConfig.xml" tofile="${basedir}/resources/oai/OAIConfig.xml.backup"  overwrite="true"/>
1047    </if>
1048    <copy file="${basedir}/resources/oai/OAIConfig.xml.in" tofile="${basedir}/resources/oai/OAIConfig.xml"  overwrite="true"/>
1049    <if><bool><available file="${basedir}/resources/cgi/gsdl3site.cfg"/></bool>
1050      <copy file="${basedir}/resources/cgi/gsdl3site.cfg" tofile="${basedir}/resources/cgi/gsdl3site.cfg.backup" overwrite="true"/>
1051    </if>
1052    <copy file="${basedir}/resources/cgi/gsdl3site.cfg.in" tofile="${basedir}/resources/cgi/gsdl3site.cfg" overwrite="true"/>
1053    <if><bool><available file="${basedir}/resources/web/global.properties"/></bool>
1054    <copy file="${basedir}/resources/web/global.properties" tofile="${basedir}/resources/web/global.properties.backup" overwrite="true"/>
1055    </if>
1056    <copy file="${basedir}/resources/web/global.properties.in" tofile="${basedir}/resources/web/global.properties" overwrite="true"/>
1057    <if><bool><available file="${basedir}/resources/web/log4j.properties"/></bool>
1058    <copy file="${basedir}/resources/web/log4j.properties" tofile="${basedir}/resources/web/log4j.properties.backup" overwrite="true"/>
1059    </if>
1060    <copy file="${basedir}/resources/web/log4j.properties.in" tofile="${basedir}/resources/web/log4j.properties" overwrite="true"/>
1061  </target>
1062  <!-- ========== Web app Targets ================================ -->
1063 
1064  <target name="prepare-web" depends="init">
1065    <mkdir dir="${web.writablehome}/applet"/>
1066    <mkdir dir="${web.writablehome}/logs"/>
1067    <mkdir dir="${web.writablehome}/logs/tmp"/>
1068  </target>
1069 
1070  <!-- if we are using java 1.5+, we need the xalan.jar file in web/WEB-INF/lib,  but if we are using java 1.4, we can't have it there.
1071       The test for whether we need it assumes we won't be trying to compile GS3 against Java versions less than 1.4. -->
1072  <target name="configure-java-version" depends="init"
1073    description="Activates or deactivates some jar libraries as needed depending on your java version">
1074
1075    <available property="have.xalan.jar" file="${web.lib}/xalan.jar"/>
1076    <condition property="need.xalan.jar">
1077      <or>
1078        <not><equals arg1="1.4" arg2="${ant.java.version}"/></not>
1079      </or>
1080    </condition>
1081
1082    <!-- if they have xalan.jar but dont need it -->
1083    <if>
1084      <bool>
1085        <and>
1086          <isset property="have.xalan.jar"/>
1087          <not><isset property="need.xalan.jar"/></not>
1088        </and>
1089      </bool>
1090      <antcall target="deactivate-xalan-jar"/>
1091    </if>
1092
1093    <!-- if they need xalan.jar but dont have it -->
1094    <if>
1095      <bool>
1096        <and>
1097          <not><isset property="have.xalan.jar"/></not>
1098          <isset property="need.xalan.jar"/>
1099        </and>
1100      </bool>
1101      <antcall target="activate-xalan-jar"/>
1102    </if>
1103
1104  </target>
1105 
1106  <target name="activate-xalan-jar">
1107    <echo>activating xalan.jar</echo>
1108    <copy file="${web.lib}/xalan.jar.tmp" tofile="${web.lib}/xalan.jar"/>
1109    <if>
1110      <bool>
1111    <and>
1112      <isset property="current.os.ismac"/>
1113      <available file="${catalina.home}/common/endorsed" type="dir"/>
1114    </and>
1115      </bool>
1116      <copy file="${web.lib}/xalan.jar.tmp" tofile="${catalina.home}/common/endorsed/xalan.jar"/>
1117    </if>
1118  </target>
1119
1120  <target name="deactivate-xalan-jar">
1121    <echo>deactivating xalan.jar</echo>
1122    <delete file="${web.lib}/xalan.jar"/>
1123    <!-- should we be deleting common/endorsed/xalan.jar on mac?? -->
1124  </target>
1125
1126
1127  <target name="prepare-collections" depends="init"
1128    description="Unpack all the collections from their svn zipped versions">
1129    <property name="collect.dir" value="${web.home}/sites/localsite/collect"/>
1130    <property name="index.zip" value="index.zip"/>
1131
1132    <echo message="installing collections..."/>
1133    <antcall target="gs2mgdemo-install"/>
1134    <antcall target="gs2mgppdemo-install"/>
1135    <antcall target="gberg-install"/>
1136    <antcall target="lucene-jdbm-demo-install"/>
1137  </target>
1138
1139  <target name="gs2mgdemo-prepare" if="collect.dir">
1140    <property name="gs2mgdemo.dir" value="${collect.dir}/gs2mgdemo"/>
1141
1142    <condition property="gs2mgdemo.present">
1143      <and>
1144        <available file="${gs2mgdemo.dir}/${index.zip}"/>
1145      </and>
1146    </condition>
1147  </target>
1148
1149  <target name="gs2mgdemo-install" if="gs2mgdemo.present" depends="gs2mgdemo-prepare">
1150    <unzip dest="${gs2mgdemo.dir}" src="${gs2mgdemo.dir}/${index.zip}" />
1151    <echo>collection gs2mgdemo installed</echo>
1152  </target>
1153
1154  <target name="gs2mgppdemo-prepare" if="collect.dir">
1155    <property name="gs2mgppdemo.dir" value="${collect.dir}/gs2mgppdemo"/>
1156 
1157    <condition property="gs2mgppdemo.present">
1158      <and>
1159        <available file="${gs2mgppdemo.dir}/${index.zip}"/>
1160      </and>
1161    </condition>
1162  </target>
1163
1164  <target name="gs2mgppdemo-install" if="gs2mgppdemo.present" depends="gs2mgppdemo-prepare">
1165    <unzip dest="${gs2mgppdemo.dir}" src="${gs2mgppdemo.dir}/${index.zip}" />
1166    <echo>collection gs2mgppdemo installed</echo>
1167  </target>   
1168
1169  <target name="gberg-prepare" if="collect.dir">
1170    <property name="gberg.dir" value="${collect.dir}/gberg"/>
1171    <available file="${gberg.dir}/index/${index.zip}" property="gberg.present"/>
1172  </target>
1173
1174  <target name="gberg-install" if="gberg.present" depends="gberg-prepare">
1175    <unzip dest="${gberg.dir}/index" src="${gberg.dir}/index/${index.zip}"/>
1176    <echo>collection gberg installed</echo>
1177  </target>
1178
1179  <target name="lucene-jdbm-demo-prepare" if="collect.dir">
1180    <property name="lucene-jdbm-demo.dir" value="${collect.dir}/lucene-jdbm-demo"/>
1181    <available file="${lucene-jdbm-demo.dir}/${index.zip}" property="lucene-jdbm-demo.present"/>
1182  </target>
1183
1184  <target name="lucene-jdbm-demo-install" if="lucene-jdbm-demo.present" depends="lucene-jdbm-demo-prepare">
1185    <unzip dest="${lucene-jdbm-demo.dir}" src="${lucene-jdbm-demo.dir}/${index.zip}"/>
1186    <echo>collection lucene-jdbm-demo installed</echo>
1187  </target>
1188
1189 
1190  <target name="install-solr-ext" depends="init" >
1191    <exec executable="ant.bat" osfamily="windows" dir="${solr-ext.home}" spawn="false">
1192      <arg value="add-service"/>
1193    </exec>
1194    <exec executable="ant" os="${os.unix}" dir="${solr-ext.home}" spawn="false">
1195      <arg value="add-service"/>
1196    </exec>
1197    <antcall target="solr-jdbm-demo-install"/>
1198  </target>
1199
1200  <target name="solr-jdbm-demo-prepare" if="collect.dir">
1201    <property name="solr-jdbm-demo.dir" value="${collect.dir}/solr-jdbm-demo"/>
1202    <available file="${solr-jdbm-demo.dir}/${index.zip}" property="solr-jdbm-demo.present"/>
1203  </target>
1204
1205  <target name="solr-jdbm-demo-install" if="solr-jdbm-demo.present" depends="solr-jdbm-demo-prepare">
1206    <unzip dest="${solr-jdbm-demo.dir}" src="${solr-jdbm-demo.dir}/${index.zip}"/>
1207    <echo>collection solr-jdbm-demo installed</echo>
1208  </target>
1209
1210  <!-- Until 64 bit Linux and Mac (Lion) machines can generate a working IsisGdl,
1211       use the ones generated on a 32 bit Linux and Mac (Leopard), respectively -->
1212  <target name="get-isisgdl" if="${current.os.isunix}">
1213    <exec executable="uname" dir="${basedir}" failonerror="false"
1214      outputproperty="uname.val">
1215      <arg value="-m"/>
1216    </exec>
1217   
1218    <if><bool><equals arg1="${uname.val}" arg2="x86_64"/></bool>
1219      <echo>Bitness: ${uname.val}</echo>
1220      <if><bool><contains string="${os.bin.dir}" substring="darwin" casesensitive="false"/></bool>
1221    <get src="http://www.greenstone.org/caveat-emptor/IsisGdl.macleopard"
1222             dest="${basedir}/gs2build/bin/${os.bin.dir}/IsisGdl"/>   
1223      </if>
1224      <if><bool><contains string="${os.bin.dir}" substring="linux" casesensitive="false"/></bool>
1225    <get src="http://www.greenstone.org/caveat-emptor/IsisGdl.bin32"
1226             dest="${basedir}/gs2build/bin/${os.bin.dir}/IsisGdl"/>
1227      </if>
1228      <chmod file="${basedir}/gs2build/bin/${os.bin.dir}/IsisGdl" perm="755"/>
1229    </if>
1230  </target>
1231
1232  <target name="set-perl-shebangs" depends="perl-for-building">
1233    <if>
1234      <bool>
1235        <and><isset property="perl.path"/>
1236          <not><equals arg1="${perl.path}" arg2=""/></not>
1237        </and>
1238      </bool>
1239
1240      <if><bool><istrue value="${current.os.iswindows}"/></bool>
1241    <property name="perl.exec" value="${perl.path}perl.exe"/>
1242    <else>
1243      <property name="perl.exec" value="${perl.path}perl"/>   
1244    </else>
1245      </if>
1246
1247      <!--<echo>**** PERLPATH: ${perl.path}</echo>-->
1248      <echo>Setting perl shebangs to Perl Exec: ${perl.exec}</echo>
1249
1250      <!-- set the shebangs in the cgi files to point to the correct perlpath -->
1251      <if>
1252    <bool><not><equals arg1="${web.home}" arg2="${web.writablehome}"></equals></not></bool>
1253    <mkdir dir="${web.writablehome}"/>
1254    <copy file="${web.home}/WEB-INF/cgi/gliserver.pl"       tofile="${web.writablehome}/WEB-INF/cgi/gliserver.pl"       overwrite="true"/>
1255    <copy file="${web.home}/WEB-INF/cgi/metadata-server.pl" tofile="${web.writablehome}/WEB-INF/cgi/metadata-server.pl" overwrite="true"/>
1256    <copy file="${web.home}/WEB-INF/cgi/checksum.pl"        tofile="${web.writablehome}/WEB-INF/cgi/checksum.pl"        overwrite="true"/>
1257      </if>
1258
1259      <rsr verbosity="1" file="${web.writablehome}/WEB-INF/cgi/gliserver.pl" pattern="^#!.*" replacement="#!${perl.exec} -w" lines="1"/>
1260      <rsr verbosity="1" file="${web.writablehome}/WEB-INF/cgi/metadata-server.pl" pattern="^#!.*" replacement="#!${perl.exec} -w" lines="1"/>
1261      <rsr verbosity="1" file="${web.writablehome}/WEB-INF/cgi/checksum.pl" pattern="^#!.*" replacement="#!${perl.exec} -w" lines="1"/>     
1262      <else>
1263    <echo>WARNING: perl.path is empty. Unable to set the shebangs in the perl files in ${web.writablehome}/WEB-INF/cgi</echo>
1264      </else>
1265    </if>
1266  </target>
1267
1268  <target name="configure-web" depends="init,perl-for-building"
1269    description="Configure only the web app config files">
1270    <!-- we want a unix path in the global.properties file -->
1271    <pathconvert targetos="unix" property="src.gsdl3.home.unix">
1272      <path path="${web.home}"/>
1273    </pathconvert>
1274    <pathconvert targetos="unix" property="src.gsdl3.writablehome.unix">
1275      <path path="${web.writablehome}"/>
1276    </pathconvert>
1277
1278    <antcall target="set-perl-shebangs" inheritAll="true" />
1279   
1280    <filter token="gsdlhome" value="${gs2build.home}"/>
1281    <filter token="gsdl3srchome" value="${basedir}"/>
1282    <filter token="gsdl3home" value="${src.gsdl3.home.unix}"/>
1283    <filter token="gsdl3writablehome" value="${src.gsdl3.writablehome.unix}"/>
1284    <filter token="gsdl3version" value="${app.version}"/>
1285    <filter token="tomcat.server" value="${tomcat.server}"/>
1286    <filter token="tomcat.port" value="${tomcat.port}"/>
1287    <filter token="derbyserver" value="${derby.server}"/>
1288    <filter token="derbyserver.port" value="${derby.server.port}"/>
1289    <filter token="perlpath" value="${escaped.perl.path}"/>
1290    <filter token="disable.collection.building" value="${disable.collection.building}"/>
1291    <copy file="${basedir}/resources/cgi/gsdl3site.cfg" tofile="${web.writablehome}/WEB-INF/cgi/gsdl3site.cfg" filtering="true" overwrite="true"/>
1292    <copy file="${basedir}/resources/web/global.properties" tofile="${web.writableclasses}/global.properties" filtering="true" overwrite="true"/>
1293    <copy file="${basedir}/resources/web/log4j.properties" tofile="${web.writableclasses}/log4j.properties" filtering="true" overwrite="true"/>
1294    <if><bool><istrue value="${gsdl3home.isreadonly}"/></bool>
1295      <!-- uncomment the writablehome properties -->
1296      <rsr verbosity="1" file="${web.writableclasses}/global.properties" pattern="^#gsdl3\.(writable{1})?home" replacement="gsdl3.$1home" />
1297    </if>
1298    <chmod file="${web.writableclasses}/global.properties" perm="644"/>
1299    <chmod file="${web.writableclasses}/log4j.properties" perm="644"/>
1300  </target>
1301
1302  <target name="compile-web" depends="init">
1303    <javac srcdir="${web.classes}"
1304      destdir="${web.classes}"
1305      includeantruntime="${compile.includeantruntime}"
1306      debug="${compile.debug}"
1307      deprecation="${compile.deprecation}"
1308      optimize="${compile.optimize}"
1309      encoding="${compile.encoding}">
1310      <classpath><path refid="compile.classpath"/></classpath>
1311    </javac>
1312  </target>
1313
1314  <target name="compile-classpath-jars" depends="init">
1315    <if><bool><available file="admin/cp.mf"/></bool>
1316      <jar destfile="admin/cp.jar" manifest="admin/cp.mf"/>
1317    </if>
1318    <if><bool><available file="${lib.java}/cp.mf"/></bool>
1319      <jar destfile="${lib.java}/cp.jar" manifest="${lib.java}/cp.mf"/>
1320    </if>
1321    <if><bool><available file="${lib.jni}/cp.mf"/></bool>
1322      <jar destfile="${lib.jni}/cp.jar" manifest="${lib.jni}/cp.mf"/>
1323    </if>
1324    <if><bool><available file="${web.lib}/cp.mf"/></bool>
1325      <jar destfile="${web.lib}/cp.jar" manifest="${web.lib}/cp.mf"/>
1326    </if>
1327    <jar destfile="cp.jar">
1328      <manifest>
1329        <attribute name="Class-Path" value="server.jar admin/cp.jar lib/java/cp.jar lib/jni/cp.jar web/WEB-INF/lib/cp.jar"/>
1330      </manifest>
1331    </jar>
1332  </target>
1333
1334  <target name="clean-classpath-jars" depends="init">
1335    <delete file="admin/cp.jar"/>
1336    <delete file="${lib.java}/cp.jar"/>
1337    <delete file="${lib.jni}/cp.jar"/>
1338    <delete file="${web.lib}/cp.jar"/>
1339    <delete file="cp.jar"/>
1340  </target>
1341
1342
1343  <target name="svnupdate-web" unless="nosvn.mode">
1344    <exec executable="svn">
1345      <arg value="update"/>
1346      <arg value="${web.writablehome}"/>
1347      <arg value="-r"/><arg value="${branch.revision}"/>
1348    </exec>
1349  </target>
1350
1351  <target name="update-web" depends="init,svnupdate-web,configure-web"
1352    description="update only the web stuff (config files)"/>
1353
1354  <!-- ======================= Tomcat Targets ========================== -->
1355 
1356  <!-- this target downloads and installs Tomcat -->
1357  <!-- we download tomcat (version 7 for Java 1.5 and later, version 5 for Java 1.4 plus the 1.4 compatibility package). -->
1358  <target name="prepare-tomcat" depends="init,setup-proxy" if="tomcat.islocal"
1359    description="downloads the appropriate version of Tomcat (Tomcat 5 if using Java 1.4, Tomcat 7 if using Java 1.5 or higher). If you want to change which version of Java you are using between 1.4 and 1.5/7 then you need to run prepare-tomcat">
1360  <if>
1361      <bool>
1362        <not><available file="${packages.home}/tomcat/.flagfile"/></not>
1363      </bool>
1364
1365      <!-- check that packages dir is there -->
1366      <mkdir dir="${packages.home}"/>
1367      <get src="http://www.greenstone.org/gs3files/${tomcat.version}.zip"
1368        dest="${packages.home}/${tomcat.version}.zip"
1369        usetimestamp="true"/>
1370      <unzip src="${packages.home}/${tomcat.version}.zip"
1371        dest="${packages.home}"/>
1372     
1373      <!-- If we are using Java 1.4, we'd be using tomcat 5.5 in which case
1374      we would need to have the tomcat compat package to work with Java 1.4-->
1375      <if>
1376    <bool><equals arg1="1.4" arg2="${ant.java.version}"/></bool>
1377    <get src="http://www.greenstone.org/gs3files/${tomcat.version}-compat.zip"
1378      dest="${packages.home}/${tomcat.version}-compat.zip"
1379      usetimestamp="true"/>
1380    <unzip src="${packages.home}/${tomcat.version}-compat.zip"
1381      dest="${packages.home}"/>
1382      </if>
1383     
1384      <!-- delete any existing tomcat -->
1385      <delete dir="${packages.home}/tomcat"/>
1386      <move todir="${packages.home}/tomcat">
1387        <fileset dir="${packages.home}/${tomcat.version}"/>
1388      </move>
1389      <!--
1390      <copy file="${basedir}/resources/tomcat/setclasspath.bat"
1391        tofile="${packages.home}/tomcat/bin/setclasspath.bat"
1392        overwrite="true"/>
1393      <copy file="${basedir}/resources/tomcat/setclasspath.sh"
1394        tofile="${packages.home}/tomcat/bin/setclasspath.sh"
1395        overwrite="true"/>
1396      -->
1397      <!-- make sure we have execute permission for the .sh files -->
1398      <chmod dir="${packages.home}/tomcat/bin" perm="ugo+rx"
1399        includes="*.sh"/>   
1400
1401      <echo file="${packages.home}/tomcat/.flagfile">
1402        the timestamp of this file is the time that tomcat was extracted from the zip files.
1403        it is used to figure out whether the files need to be refreshed or not in `ant prepare-tomcat`
1404      </echo>
1405
1406      <!-- this is not strictly a prepare tomcat thing, but if one changes
1407      Java, then they need to change tomcat as well, so might as well call
1408      it here -->
1409      <antcall target="configure-java-version"/>
1410      <else>
1411        <echo>Tomcat has been prepared, will not prepare</echo>
1412        <echo>Delete ${packages.home}/tomcat/.flagfile to force refresh</echo>
1413      </else>
1414
1415    </if>
1416
1417  </target> 
1418 
1419  <target name="configure-tomcat" depends="init,configure-tomcat-local,configure-tomcat-external"/>
1420 
1421  <target name="configure-tomcat-local" depends="init,perl-for-building" if="tomcat.islocal">
1422    <!-- re-setup the server.xml file -->
1423    <copy file="${basedir}/resources/tomcat/server_tomcat${tomcat.version.major}.xml"
1424        tofile="${packages.home}/tomcat/conf/server.xml" overwrite="true">
1425      <filterset>
1426        <filter token="port" value="${tomcat.port}"/>
1427        <filter token="shutdown-port" value="${tomcat.shutdown.port}"/>
1428      </filterset>
1429    </copy>
1430
1431    <!-- set up the solr context -->
1432
1433    <!-- First work out the IPv4 address for this machine -->
1434    <exec executable="${basedir}/bin/script/IPv4.sh" os="${os.unix}" failonerror="false" outputproperty="ipv4.val">
1435      <arg value="-format-for-tomcat-context"/>
1436    </exec>
1437    <exec executable="${basedir}/bin/script/IPv4.bat" osfamily="windows" failonerror="false" outputproperty="ipv4.val">
1438      <arg value="-format-for-tomcat-context"/>
1439    </exec>
1440
1441    <copy file="${basedir}/ext/solr/solr-tomcat-context.xml.in" tofile="${packages.home}/tomcat/conf/Catalina/localhost/solr.xml" overwrite="true">
1442      <filterset>
1443        <filter token="gsdl3webhome" value="${web.writablehome}"/>
1444    <filter token="tomcathome" value="${basedir}/packages/tomcat"/>
1445    <filter token="IPv4" value="${ipv4.val}"/>
1446      </filterset>
1447    </copy>
1448
1449    <!-- set up the greenstone3 context, it may have a custom name specified in build.properties -->
1450    <if><bool><not><equals arg1="greenstone3" arg2="${custom.context}"></equals></not></bool>
1451        <copy file="${basedir}/resources/tomcat/greenstone3.xml" tofile="${basedir}/resources/tomcat/${custom.context}.xml" overwrite="true"/>
1452    </if>
1453    <copy file="${basedir}/resources/tomcat/${custom.context}.xml" tofile="${packages.home}/tomcat/conf/Catalina/localhost/${custom.context}.xml" overwrite="true">
1454      <filterset>
1455        <filter token="gsdl3webhome" value="${web.home}"/>
1456        <filter token="gsdl3webwritablehome" value="${web.writablehome}"/>
1457    <filter token="privilegedattribute" value="${privileged.attribute}"/>
1458    <filter token="allowedIPs" value="${allowed.IPs}"/>
1459    <filter token="derbyserver" value="${derby.server}"/>
1460    <filter token="derbyserverport" value="${derby.server.port}"/>
1461      </filterset>
1462    </copy>
1463    <if>
1464        <bool>
1465            <and>
1466                <available file="${packages.home}/tomcat/conf/Catalina/localhost/greenstone3.xml"/>
1467                <not><equals arg1="greenstone3" arg2="${custom.context}"></equals></not>
1468            </and>
1469        </bool>
1470        <delete file="${packages.home}/tomcat/conf/Catalina/localhost/greenstone3.xml"/>
1471    </if>
1472   
1473    <!-- set up the greenstone3 web.xml file -->
1474    <copy file="${basedir}/resources/tomcat/web.xml" tofile="${packages.home}/tomcat/conf/web.xml" overwrite="true">
1475      <filterset>
1476    <filter token="perlpath" value="${perl.path}"/>
1477      </filterset>
1478    </copy>
1479  </target>
1480 
1481  <target name="configure-tomcat-external" depends="init" unless="tomcat.islocal">
1482    <!-- re-setup the server.xml file -->
1483    <!-- need to edit the config file, or do we get the user to do this???-->
1484  </target>
1485
1486  <target name="configure-solr-ext" depends="init" >
1487    <!-- re-setup the web/ext/solr/solr.xml file -->
1488    <copy file="${web.home}/ext/solr/solr.xml.in"
1489      tofile="${gsdl3.writablehome}/ext/solr/solr.xml" filtering="true" overwrite="true">
1490      <filterset>
1491        <filter token="gsdl3.home" value="${src.gsdl3.home.unix}"/>
1492        <filter token="gsdl3.writablehome" value="${src.gsdl3.writablehome.unix}"/>
1493      </filterset>
1494    </copy>
1495  </target>
1496 
1497  <!-- This target runs tomcat's "bin/catalina.bat(.sh) jpda start"
1498       to allow debugging the running GS3 server in Eclipse. See the instructions at
1499       http://www.wikijava.org/wiki/Debugging_a_servlet_with_tomcat_and_Eclipse_tutorial
1500       on how to use this with eclipse
1501    -->
1502  <target name="debug-start-tomcat" description="Startup Tomcat for debugger" depends="init" if="tomcat.islocal">
1503    <property name="tomcat.classpath" refid="local.tomcat.classpath"/>
1504    <property name="tomcat.path" refid="local.tomcat.path"/>
1505
1506    <if><bool>
1507    <isset property="fedora.maxpermsize"/></bool>
1508      <property name="catalina.opts" value="-Djava.util.prefs.syncInterval=2000000 -DGSDL3HOME=$GSDL3HOME -DGSDLOS=$GSDLOS -DPATH=$PATH -Xmx800M ${fedora.maxpermsize}"/>
1509      <else>
1510    <property name="catalina.opts" value="-Djava.util.prefs.syncInterval=2000000 -DGSDL3HOME=$GSDL3HOME -DGSDLOS=$GSDLOS -DPATH=$PATH -Xmx800M"/>
1511      </else>
1512    </if>
1513
1514    <echo file="${catalina.home}/bin/setenv.bat">set CLASSPATH=${tomcat.classpath}</echo>
1515    <echo file="${catalina.home}/bin/setenv.sh">export CLASSPATH=${tomcat.classpath}</echo>
1516   
1517    <exec executable="${catalina.home}/bin/catalina.sh" os="${os.unix}" dir="${catalina.home}/bin" spawn="false">
1518      <arg value="jpda" />
1519      <arg value="start" />
1520      <env key="JPDA_ADDRESS" value="8000"/> <!-- for debugging Tomcat in Eclipse -->
1521      <env key="JPDA_TRANSPORT" value="dt_socket"/> <!-- for debugging Tomcat in Eclipse -->
1522      <!--<env key="GSDLOS" value="linux"/> do we need this?? -->
1523      <env key="PATH" path="${tomcat.path}"/>
1524      <env key="CATALINA_OPTS" value="${catalina.opts}"/>
1525      <env key="CATALINA_HOME" value="${catalina.home}"/>
1526      <env key="CLASSPATH" path="${tomcat.classpath}"/>
1527      <env key="LD_LIBRARY_PATH" path="${env.LD_LIBRARY_PATH}:${lib.jni}"/>
1528      <env key="DYLD_LIBRARY_PATH" path="${env.DYLD_LIBRARY_PATH}:${lib.jni}:${gdbm.home}/lib"/> <!-- for mac os --> <!-- need gdbm here these days ??-->
1529      <env key="WNHOME" path="${wn.home}"/>
1530      <env key="FEDORA_HOME" path="${fedora.home}"/>
1531    </exec>
1532    <exec executable="${catalina.home}/bin/catalina.bat" osfamily="windows" dir="${catalina.home}/bin" spawn="true">
1533      <arg value="jpda" />
1534      <arg value="start" />
1535      <env key="JPDA_ADDRESS" value="8000"/> <!-- for debugging Tomcat in Eclipse -->
1536      <env key="JPDA_TRANSPORT" value="dt_socket"/> <!-- for debugging Tomcat in Eclipse -->
1537      <env key="GSDLOS" value="windows"/>
1538      <env key="GSDL3HOME" value="${basedir}"/>
1539      <env key="Path" path="${tomcat.path}"/>
1540      <env key="PATH" path="${tomcat.path}"/>
1541      <env key="CATALINA_OPTS" value="${catalina.opts}"/>
1542      <env key="CATALINA_HOME" value="${catalina.home}"/>
1543      <env key="CLASSPATH" path="${tomcat.classpath}"/>
1544      <env key="FEDORA_HOME" path="${fedora.home}"/>
1545    </exec>
1546    <!-- wait for the server to startup in case other targets need it running -->
1547    <waitfor maxwait="5" maxwaitunit="second">
1548      <and>
1549        <socket server="${tomcat.server}" port="${tomcat.port}"/>
1550        <http url="http://${tomcat.server}:${tomcat.port}${app.path}/index.html"/>
1551      </and>
1552    </waitfor>
1553  </target> 
1554 
1555  <target name="start-tomcat" description="Startup only Tomcat" depends="check-tomcat-started">
1556
1557    <if><bool><istrue value="${tomcat.isstarted}"/></bool>
1558      <echo>**************************************</echo>
1559      <echo>A WEB SERVER IS ALREADY RUNNING ON http://${tomcat.server}:${tomcat.port}. NOT STARTING.</echo>
1560      <echo>**************************************</echo>
1561      <else>
1562    <antcall target="force-start-tomcat"/>
1563      </else>
1564      </if>
1565  </target>
1566
1567  <!-- Another way: http://ptrthomas.wordpress.com/2006/03/25/how-to-start-and-stop-tomcat-from-ant/ -->
1568  <target name="force-start-tomcat" description="Startup only Tomcat" depends="init" if="tomcat.islocal">
1569
1570    <property name="tomcat.classpath" refid="local.tomcat.classpath"/>
1571    <property name="tomcat.path" refid="local.tomcat.path"/>
1572
1573    <if><bool>
1574    <isset property="fedora.maxpermsize"/></bool>
1575      <property name="catalina.opts" value="-Djava.util.prefs.syncInterval=2000000 -DGSDL3HOME=$GSDL3HOME -DGSDLOS=$GSDLOS -DPATH=$PATH -Xmx800M ${fedora.maxpermsize}"/>
1576      <else>
1577    <property name="catalina.opts" value="-Djava.util.prefs.syncInterval=2000000 -DGSDL3HOME=$GSDL3HOME -DGSDLOS=$GSDLOS -DPATH=$PATH -Xmx800M"/>
1578      </else>
1579    </if>
1580
1581    <echo file="${catalina.home}/bin/setenv.bat">set CLASSPATH=${tomcat.classpath}</echo>
1582    <echo file="${catalina.home}/bin/setenv.sh">export CLASSPATH=${tomcat.classpath}</echo>
1583
1584    <!-- using osfamily instead of testing os against os.windows list of recognised windows versions
1585     so that future windows versions are included. See http://simonharrer.wordpress.com/tag/osfamily/
1586    Can't use the osfamily test for linux-type machines as a group since osfamily=unix is separate from osfamily=mac,
1587    see http://ant-contrib.sourceforge.net/tasks/tasks/osfamily.html -->
1588
1589    <exec executable="${catalina.home}/bin/startup.sh" os="${os.unix}" dir="${catalina.home}/bin" spawn="false">
1590      <!--<env key="GSDLOS" value="linux"/> do we need this?? -->
1591      <env key="GSDL3HOME" value="${basedir}"/>
1592      <env key="PATH" path="${tomcat.path}"/>
1593      <env key="CATALINA_OPTS" value="${catalina.opts}"/>
1594      <env key="CATALINA_HOME" value="${catalina.home}"/>
1595      <env key="CLASSPATH" path="${tomcat.classpath}"/>
1596      <env key="LD_LIBRARY_PATH" path="${env.LD_LIBRARY_PATH}:${lib.jni}"/>
1597      <env key="DYLD_LIBRARY_PATH" path="${env.DYLD_LIBRARY_PATH}:${lib.jni}:${gdbm.home}/lib"/> <!-- for mac os --> <!-- need gdbm here these days ??-->
1598      <env key="WNHOME" path="${wn.home}"/>
1599      <env key="FEDORA_HOME" path="${fedora.home}"/>
1600    </exec>
1601    <exec executable="${catalina.home}/bin/startup.bat" osfamily="windows" dir="${catalina.home}/bin" spawn="true">
1602      <env key="GSDLOS" value="windows"/>
1603      <env key="GSDL3HOME" value="${basedir}"/>
1604      <env key="Path" path="${tomcat.path}"/>
1605      <env key="PATH" path="${tomcat.path}"/>
1606      <env key="CATALINA_OPTS" value="${catalina.opts}"/>
1607      <env key="CATALINA_HOME" value="${catalina.home}"/>
1608      <env key="CLASSPATH" path="${tomcat.classpath}"/>
1609      <env key="FEDORA_HOME" path="${fedora.home}"/>
1610    </exec>
1611    <!-- wait for the server to startup in case other targets need it running -->
1612    <waitfor maxwait="5" maxwaitunit="second">
1613      <and>
1614        <socket server="${tomcat.server}" port="${tomcat.port}"/>
1615        <http url="http://${tomcat.server}:${tomcat.port}${app.path}/index.html"/>
1616      </and>
1617    </waitfor>
1618
1619  </target>
1620
1621  <!--ant task http: http://www.jajakarta.org/ant/ant-1.6.1/docs/ja/manual/api/org/apache/tools/ant/taskdefs/condition/Http.html-->
1622  <target name="reconfigure" description="Reconfigure the message router">
1623    <waitfor maxwait="5" maxwaitunit="second">
1624      <http url="http://${tomcat.server}:${tomcat.port}${app.path}${server.default.servlet}?a=s&amp;sa=c"/>
1625    </waitfor>
1626  </target>
1627
1628  <!--Command-line args to Ant: http://www.jguru.com/faq/view.jsp?EID=471794-->
1629  <target name="reconfigure-collection" description="Reconfigure the collection">
1630    <waitfor maxwait="5" maxwaitunit="second">
1631      <http url="http://${tomcat.server}:${tomcat.port}${app.path}${server.default.servlet}?a=s&amp;sa=c&amp;sc=${collection}"/>
1632    </waitfor>
1633  </target>
1634
1635  <!-- windows: do we want to launch a webrowser?? -->
1636  <!-- shouldn't this test whether anything is running first?
1637       It's safer to always attempt to stop tomcat: that way we won't be dependent on the right time
1638       to check whether the server is stopped or still running before attempting to start again.
1639       This target, which was recently called force-stop-tomcat for a while but is back to being
1640       called stop-tomcat, now hides the Java exception output that appears whenever tomcat is already
1641       stopped as happens when stop-tomcat is called consecutively. -->
1642  <target name="force-stop-tomcat" description="Shutdown only Tomcat" depends="init" if="tomcat.islocal">
1643    <exec executable="${catalina.home}/bin/shutdown.sh" os="${os.unix}" dir="${catalina.home}/bin" spawn="false">
1644      <env key="FEDORA_HOME" path="${fedora.home}"/>
1645      <env key="CATALINA_HOME" value="${catalina.home}"/>
1646      <arg line=">/dev/null 2>&amp;1"/>
1647    </exec>
1648    <exec executable="${catalina.home}/bin/shutdown.bat" osfamily="windows" dir="${catalina.home}/bin" spawn="false">
1649      <env key="FEDORA_HOME" path="${fedora.home}"/>
1650      <env key="CATALINA_HOME" value="${catalina.home}"/>
1651      <arg line=">nul 2>&amp;1"/>
1652    </exec>   
1653  </target>
1654
1655  <!-- Can also try the "socket" condition in place of the "http" condition
1656       And also use a <waitfor> in place of <condition>, such as:
1657       <waitfor maxwait="5" maxwaitunit="second" timeoutproperty="tomcat.isstopped"><http url="..."/></waitfor>
1658       The http URL resolves to host:port/greenstone3
1659       Condition uses <http/> rather than <socket/> for testing, since if the server was stopped, the socket
1660       might still be in use for some moments. We test the URL with the http condition since it's likelier to
1661       fail sooner if the server has indeed been stopped. -->
1662  <target name="check-tomcat-running">
1663    <condition property="tomcat.isrunning">
1664      <!--<http url="http://${tomcat.server}:${tomcat.port}${app.path}"/>-->
1665      <http url="http://${tomcat.server}:${tomcat.port}"/>
1666    </condition>
1667  </target>
1668 
1669  <!-- Need a copy of the check-tomcat-running target with a distinct property, because ant restart runs
1670       both stop and start, both of which need to do tomcat checks. Each property can be set only once during
1671       an invocation with ant. So ant restart will need two properties to store each of the tomcat checks -->
1672  <target name="check-tomcat-started">
1673    <condition property="tomcat.isstarted">
1674      <http url="http://${tomcat.server}:${tomcat.port}"/>
1675    </condition>
1676  </target>
1677
1678
1679
1680  <!-- stop-tomcat checks if the tomcat server is already running. If it appears to be running
1681       (regardless of whether tomcat was just starting to shut down), this target calls force-stop-tomcat
1682       to issue the shutdown command to tomcat. Then it waits for at most 15 seconds for the server to
1683       actually stop by checking the socket at which tomcat listens every second, printing a warning
1684       at the end of the max wait time of 15 seconds if tomcat was still running. -->
1685  <target name="stop-tomcat" description="Shutdown only Tomcat if running" depends="check-tomcat-running" if="tomcat.isrunning">
1686     <antcall target="force-stop-tomcat"/>
1687
1688     <property name="wait.numchecks" value="15"/>
1689     <echo>Waiting for the server to shutdown... (${wait.numchecks} seconds max)</echo>
1690     <waitfor maxwait="${wait.numchecks}" maxwaitunit="second" checkevery="1" checkeveryunit="second" timeoutproperty="tomcat.timedout">
1691       <not><socket server="${tomcat.server}" port="${tomcat.port}"/></not>
1692     </waitfor>
1693     
1694     <if>
1695       <bool>
1696     <isset property="${tomcat.timedout}"/>
1697       </bool>
1698       <property name="tomcat.isrunning" value="true"/>
1699       <echo>WARNING: Checked the socket ${wait.numchecks} times, but port ${tomcat.port} is still busy.</echo>
1700       <else>
1701     <echo>Tomcat is stopped.</echo>
1702     <property name="tomcat.isrunning" value="false"/>
1703       </else>
1704     </if>
1705  </target>
1706
1707  <target name="restart-tomcat" description="Shutdown and restart only Tomcat" depends="init,stop-tomcat,force-start-tomcat"/>
1708
1709  <target name="setup-catalina-ant-tasks">
1710    <!-- Configure the custom Ant tasks for the Tomcat Manager application -->
1711    <taskdef name="deploy"    classname="org.apache.catalina.ant.DeployTask"
1712      classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
1713    <taskdef name="list"      classname="org.apache.catalina.ant.ListTask"
1714      classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
1715    <taskdef name="reload"    classname="org.apache.catalina.ant.ReloadTask"
1716      classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
1717    <taskdef name="resources" classname="org.apache.catalina.ant.ResourcesTask"
1718      classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
1719    <taskdef name="roles"     classname="org.apache.catalina.ant.RolesTask"
1720      classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
1721    <taskdef name="start"     classname="org.apache.catalina.ant.StartTask"
1722      classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
1723    <taskdef name="stop"      classname="org.apache.catalina.ant.StopTask"
1724      classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
1725    <taskdef name="undeploy"  classname="org.apache.catalina.ant.UndeployTask"
1726      classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
1727  </target>
1728
1729  <!-- http://blog.andrewbeacock.com/2007/11/how-to-truncate-log-file-using-ubuntu.html
1730    Doing "cat </dev/null > packages/tomcat/logs/catalina.out" doesn't work as an ant target.
1731    It seems to have a problem with cat or </dev/null, with or without the < sign. -->
1732  <target name="reset-logs" description="Empties catalina.out, greenstone.log and contents of web/logs/tmp">
1733    <echo>Truncating catalina.out, solr.log, greenstone.log and server.log, and emptying ${web.writablehome}/logs/tmp</echo>   
1734    <exec executable="rm" os="${os.unix}" dir="${catalina.home}/logs" spawn="false">
1735      <arg value="-f"/>
1736      <arg value="catalina.out"/>
1737    </exec>
1738    <exec executable="rm" os="${os.unix}" dir="${web.writablehome}/logs" spawn="false">
1739      <arg value="-f"/>
1740      <arg value="greenstone.log"/>
1741    </exec>
1742    <exec executable="rm" os="${os.unix}" dir="${web.writablehome}/logs" spawn="false">
1743      <arg value="-f"/>
1744      <arg value="server.log"/>
1745    </exec>
1746
1747    <exec executable="touch" os="${os.unix}" dir="${catalina.home}/logs"
1748    spawn="false">
1749      <arg value="catalina.out"/>
1750    </exec>
1751    <exec executable="touch" os="${os.unix}" dir="${web.writablehome}/logs"
1752      spawn="false">
1753      <arg value="greenstone.log"/>
1754    </exec>
1755    <exec executable="touch" os="${os.unix}" dir="${web.writablehome}/logs"
1756      spawn="false">
1757      <arg value="server.log"/>
1758    </exec>
1759
1760    <exec executable="cmd" osfamily="windows" dir="${catalina.home}/logs" spawn="false">
1761      <arg line="/c echo. > catalina.out"/>
1762    </exec>
1763    <exec executable="cmd" osfamily="windows" dir="${web.writablehome}/logs" spawn="false">
1764      <arg line="/c echo. > greenstone.log"/>
1765    </exec>
1766    <exec executable="cmd" osfamily="windows" dir="${web.writablehome}/logs" spawn="false">
1767      <arg line="/c echo. > server.log"/>
1768    </exec>
1769
1770    <!-- if ext/solr/logs/solr.log exists, truncate it -->
1771    <if><bool><available file="${solr-ext.home}/logs/solr.log" type="file"/></bool>     
1772        <exec executable="rm" os="${os.unix}" dir="${solr-ext.home}/logs" spawn="false">
1773          <arg value="-f"/>
1774          <arg value="solr.log"/>
1775        </exec>
1776        <exec executable="touch" os="${os.unix}" dir="${solr-ext.home}/logs" spawn="false">
1777          <arg value="solr.log"/>
1778        </exec>   
1779        <exec executable="cmd" osfamily="windows" dir="${solr-ext.home}/logs" spawn="false">
1780          <arg line="/c echo. > solr.log"/>
1781        </exec>
1782    </if>
1783   
1784    <if>
1785      <bool><available file="${web.writablehome}/logs/tmp" type="dir"/></bool>
1786      <delete>
1787    <fileset dir="${web.writablehome}/logs/tmp" includes="**/*"/>
1788      </delete>
1789    </if>
1790  </target>
1791
1792  <target name="clear-tomcat-sessions" description="Clear the Tomcat Session info." depends="init">
1793    <exec executable="cmd" osfamily="windows" dir="${catalina.home}/work/Catalina/localhost/greenstone3" spawn="false">
1794      <arg line="/c echo. > SESSIONS.ser"/>
1795    </exec>
1796    <exec executable="rm" os="${os.unix}" dir="${catalina.home}/work/Catalina/localhost/greenstone3" spawn="false">
1797      <arg value="-f"/>
1798      <arg value="SESSIONS.ser"/>
1799    </exec>
1800
1801  </target>
1802  <!-- ======================= ant Targets ============================ -->
1803  <target name="prepare-ant" depends="init">
1804    <if>
1805      <bool>
1806        <not><available file="${packages.home}/ant/.flagfile"/></not>
1807      </bool>
1808
1809      <get src="http://www.greenstone.org/gs3files/apache-ant-1.7.0-bin.zip"
1810        dest="${packages.home}/apache-ant-1.7.0-bin.zip"
1811        usetimestamp="true"/>
1812      <unzip src="${packages.home}/apache-ant-1.7.0-bin.zip"
1813        dest="${packages.home}"/>
1814      <move todir="${packages.home}/ant">
1815        <fileset dir="${packages.home}/apache-ant-1.7.0"/>
1816      </move>
1817      <echo file="${packages.home}/ant/.flagfile">
1818        the timestamp of this file is the time that ant was extracted from the zip files.
1819        it is used to figure out whether the files need to be refreshed or not in `ant prepare-ant`
1820      </echo>
1821
1822      <else>
1823        <echo>Ant has been prepared, will not prepare</echo>
1824        <echo>Delete ${packages.home}/ant/.flagfile to force refresh</echo>
1825      </else>
1826
1827    </if>
1828  </target>
1829
1830  <!-- ======================= Admin Targets ============================ --> 
1831
1832  <!-- This target won't work with Eclipse because the SecureInputHandler used below conflicts with it.
1833    See http://www.dcepler.net/post.cfm/hiding-password-input-in-ant
1834    But you can do: echo mypassword | ant config-admin -->
1835  <target name="config-admin" description="Reset admin password">
1836    <input addproperty="admin.password" defaultvalue="admin" message="New admin password (3-20 characters):&gt;">
1837      <handler classname="org.apache.tools.ant.input.SecureInputHandler" /> <!-- password won't be visible on screen -->
1838    </input>
1839    <!--<echo>PWD: ${admin.password}</echo>-->
1840    <antcall target="update-userdb">
1841      <param name="user.username" value="admin"/>
1842      <param name="user.password" value="${admin.password}"/>
1843      <param name="user.groups" value=""/>
1844      <param name="user.status" value=""/>
1845      <param name="user.comment" value="Password updated."/>
1846      <param name="user.email" value=""/>
1847    </antcall>
1848  </target>
1849
1850  <target name="config-user" description="Add or modify users" depends="get-user-data,update-userdb"/>
1851
1852  <target name="get-user-data" description="Get user details">
1853    <input addproperty="user.username" message="Username:&gt;"/>
1854    <input addproperty="user.password" defaultvalue="" message="Password (3-20 characters):&gt;">
1855      <handler classname="org.apache.tools.ant.input.SecureInputHandler" /> <!-- password won't be visible on screen -->
1856    </input>
1857    <input addproperty="user.groups" defaultvalue="" message="Groups (comma-separated list, e.g. personal-collections-editor):&gt;"/>
1858    <input addproperty="user.status" defaultvalue="true" message="Enabled (true/false):&gt;"/>
1859    <input addproperty="user.comment" defaultvalue="" message="Comment:&gt;"/>
1860    <input addproperty="user.email" defaultvalue="" message="Email:&gt;"/>
1861  </target>
1862
1863  <!-- This target won't work with Eclipse because the SecureInputHandler used below conflicts with it.
1864       See http://www.dcepler.net/post.cfm/hiding-password-input-in-ant
1865       But you can do: echo mypassword | ant config-admin -->
1866  <target name="update-userdb" description="Add or modify users" depends="start-derby">
1867
1868    <!--
1869       We're now using derby networked server, so stopping and starting tomcat is not necessary.
1870       For embedded derby: stop tomcat if running, since derby db is embedded
1871       and only allows connections from one jvm instance at a time
1872     See http://db.apache.org/derby/papers/DerbyTut/embedded_intro.html
1873     The ${tomcat.isrunning} property is set by the depends-target "check-tomcat-running" -->
1874   
1875    <!-- Need the derby networked server to be running in order to modify the usersDB.
1876     The start-derby task will check if derby is already running (if not, ${derby.isstarted} will
1877     be false) and will only start up networked derby if it is not already running.
1878     The ${derby.isstarted} property is set by the depends-target "start-derby", since it won't
1879     set the property if called with antcall (like launching in a subshell). Have to use 'depends'.
1880     We'll check ${derby.isstarted} at the end to stop derby again if we had to start it up now.-->
1881    <!--<antcall target="start-derby"/>-->
1882
1883    <!-- wait a max of 5 seconds for the derbyserver to have started up -->
1884    <waitfor maxwait="5" maxwaitunit="second">
1885      <socket server="${derby.server}" port="${derby.server.port}"/>
1886    </waitfor>
1887
1888    <!--<echo>${admin.password}</echo>--> <!-- for testing -->
1889    <java classname="org.greenstone.gsdl3.util.ModifyUsersDB">
1890      <classpath refid="compile.classpath"/> <!--for ${web.lib}/gsdl3.jar and supporting files-->
1891      <sysproperty key="gsdl3.writablehome" value="${gsdl3.writablehome}" /> <!-- passes -D<syspropKey=syspropVal> to java class ModifyUsersDB. Available in java code as System.getProperty("syspropKey") -->
1892      <arg file="${web.home}/etc/usersDB"/>
1893      <arg value="${user.username}"/>
1894      <arg value="password=${user.password}"/>
1895      <arg value="groups=${user.groups}"/>
1896      <arg value="status=${user.status}"/>
1897      <arg value="comment=${user.comment}"/>
1898      <arg value="email=${user.email}"/>
1899    </java>
1900
1901    <!-- Need to stop networked derby again if we ran it for this target with the depends=start-derby call.
1902     The test here is for <not>derby.isstarted</not>, as the property would be the same as before
1903     derby was started, since properties are immutable within a single ant command. -->
1904    <if>
1905      <bool>
1906    <not><istrue value="${derby.isstarted}"/></not>
1907      </bool>
1908      <antcall target="force-stop-derby"/>
1909    </if>
1910
1911  </target>
1912
1913
1914  <!-- ======================= Axis Targets ============================ --> 
1915 
1916  <target name="prepare-axis" depends="init">
1917
1918    <if>
1919      <bool>
1920        <not><available file="${packages.home}/axis/.flagfile"/></not>
1921      </bool>
1922
1923      <get src="http://www.greenstone.org/gs3files/${axis.zip.version}"
1924        dest="${packages.home}/${axis.zip.version}"
1925        usetimestamp="true"/>
1926      <unzip src="${packages.home}/${axis.zip.version}"
1927        dest="${packages.home}"/>
1928      <move todir="${packages.home}/axis">
1929        <fileset dir="${packages.home}/${axis.dir.version}"/>
1930      </move>
1931      <!-- install axis into greenstone web app -->
1932      <copy todir="${web.lib}">
1933        <fileset dir="${packages.home}/axis/webapps/axis/WEB-INF/lib">
1934          <include name="*.jar"/>
1935        </fileset>
1936      </copy>
1937      <copy todir="${web.home}">
1938        <fileset dir="${packages.home}/axis/webapps/axis/">
1939          <include name="*.jsp"/>
1940          <include name="*.jws"/>
1941        </fileset>
1942      </copy>
1943      <copy tofile="${web.home}/axis.html" file="${packages.home}/axis/webapps/axis/index.html"/>
1944      <copy todir="${web.classes}">
1945        <fileset dir="${packages.home}/axis/webapps/axis/WEB-INF/classes">
1946          <include name="*.properties"/>
1947        </fileset>
1948      </copy>
1949      <echo file="${packages.home}/axis/.flagfile">
1950        the timestamp of this file is the time that axis was extracted from the zip files.
1951        it is used to figure out whether the files need to be refreshed or not in `ant prepare-axis`
1952      </echo>
1953
1954      <else>
1955        <echo>Axis has been prepared, will not prepare</echo>
1956        <echo>Delete ${packages.home}/axis/.flagfile to force refresh</echo>
1957      </else>
1958
1959    </if>
1960  </target>
1961
1962  <target name="soap-deploy-site" depends="init,get-sitename,get-siteuri,get-webservices,create-deployment-files,deploy-site"
1963    description="Deploy a SOAP web service for a local Greenstone site. Tomcat must be running for this to work."/>
1964   
1965    <target name="deploy-site">
1966    <java classname="org.apache.axis.client.AdminClient">
1967      <classpath refid="compile.classpath"/>
1968      <arg value="-l"/>
1969      <arg value="http://${tomcat.server}:${tomcat.port}${app.path}/servlet/AxisServlet"/>
1970      <arg file="${basedir}/resources/soap/deploy.wsdd"/>
1971    </java>
1972    <delete file="${basedir}/resources/soap/deploy.wsdd"/> <!--clean up, no longer used-->
1973  </target>
1974 
1975  <target name="soap-undeploy-site" depends="get-undeploy-service-name"
1976    description="Undeploy a SOAP web service for a local Greenstone site. Tomcat must be running for this to work.">
1977    <filter token="servicesname" value="${axis.undeploy.servicename}"/>
1978    <copy file="${basedir}/resources/soap/undeploy-site.wsdd.template"
1979      tofile="${basedir}/resources/soap/undeploy.wsdd"
1980      filtering="true"
1981      overwrite="true"/>
1982    <java classname="org.apache.axis.client.AdminClient">
1983      <classpath refid="compile.classpath"/>
1984      <arg value="-l"/>
1985      <arg value="http://${tomcat.server}:${tomcat.port}${app.path}/servlet/AxisServlet"/>
1986      <arg file="${basedir}/resources/soap/undeploy.wsdd"/>
1987    </java>
1988    <delete file="${basedir}/resources/soap/undeploy.wsdd"/> <!--clean up, no longer used-->
1989  </target> 
1990
1991  <!-- this target used to deploy the default web service SOAPServer (base.webservice.name) on the localsite server
1992  with the default servicename of localsite-->
1993  <target name="deploy-localsite" depends="init"
1994    description="Deploy the SOAP server for localsite. Will start and stop Tomcat.">
1995    <antcall target="force-start-tomcat"/>
1996    <echo>Deploying ${base.webservice.name} web services for localsite under service name: localsite</echo>
1997    <antcall target="create-deployment-files">
1998      <param name="axis.sitename" value="localsite"/>
1999      <param name="axis.servicesname" value="${base.webservice.name}"/>
2000      <param name="axis.siteuri" value="localsite"/>
2001    </antcall>
2002    <antcall target="deploy-site">
2003      <param name="axis.sitename" value="localsite"/>
2004      <param name="axis.servicesname" value="${base.webservice.name}"/>
2005      <param name="axis.siteuri" value="localsite"/>
2006    </antcall>
2007    <echo>The Greenstone server has been started up. If you do not want it running, please type: ant stop.</echo>
2008  </target>
2009   
2010  <target name="get-sitename" unless="axis.sitename">
2011    <input addproperty="axis.sitename" defaultvalue="localsite">What site do you want to deploy services for?
2012Press Enter for default:localsite</input>
2013  </target>
2014
2015  <target name="get-undeploy-service-name" unless="axis.undeploy.servicename">
2016    <input addproperty="axis.undeploy.servicename" defaultvalue="localsite">Please enter the full name of the service you wish to undeploy.
2017To find out which web services you've got deployed, point your browser to http://HOST:PORT/greenstone3/services
2018Or press Enter for undeploying the default:localsite /&gt;</input>
2019     <echo>Name of service to undeploy: ${axis.undeploy.servicename}</echo>
2020  </target>
2021
2022  <target name="get-webservices" unless="axis.servicesname">
2023    <input addproperty="axis.servicesname" defaultvalue="${base.webservice.name}">Which set of web services do you want to deploy?
2024Choose from: ${web.services.list}
2025Or press Enter for default:${base.webservice.name} /&gt;</input>
2026    <echo>${axis.servicesname}</echo>
2027  </target>
2028
2029  <target name="get-siteuri" depends="get-sitename,get-webservices" unless="axis.siteuri">
2030    <input addproperty="axis.siteuri" defaultvalue="${axis.servicesname}${axis.sitename}">What name do you want the service to have? (Press Enter for default:${axis.servicesname}${axis.sitename})</input>
2031    <echo>Site: ${axis.sitename}, services: ${axis.servicesname}, servicesname: ${axis.siteuri}</echo>
2032  </target>
2033
2034  <target name="set-soapmethod" description="Determines whether the service in the wsdd should have the style attribute set to message or the provider attribute set to java:RPC"  if="axis.servicesname">
2035   <condition property="soap.method" value="provider='java:MSG' style='message' use='literal'">
2036      <equals arg1="${axis.servicesname}" arg2="${base.webservice.name}"/>
2037    </condition>
2038   
2039   <!--everything else defaults to java:RPC at present-->
2040   <condition property="soap.method" value="provider='java:RPC'">
2041     <not>
2042      <equals arg1="${axis.servicesname}" arg2="${base.webservice.name}"/>
2043    </not>
2044    </condition>
2045  </target>
2046   
2047  <target name="create-deployment-files" depends="set-soapmethod" if="axis.sitename">
2048    <filter token="sitename" value="${axis.sitename}"/>
2049    <filter token="siteuri" value="${axis.siteuri}"/>
2050    <filter token="servicesname" value="${axis.servicesname}"/>
2051    <filter token="soapmethod" value="${soap.method}"/>
2052    <copy file="${basedir}/resources/soap/site.wsdd.template"
2053      tofile="${basedir}/resources/soap/deploy.wsdd"
2054      filtering="true"
2055      overwrite="true"/>
2056    <!-- create the java files and compile them -->
2057    <copy file="${basedir}/resources/java/${axis.servicesname}.java.in"
2058      tofile="${src.gsdl3.home}/${axis.servicesname}${axis.sitename}.java"
2059      filtering="true"
2060      overwrite="true"/>
2061    <mkdir dir="${build.home}"/>
2062    <javac srcdir="${src.home}"
2063      destdir="${build.home}"
2064      includeantruntime="${compile.includeantruntime}"
2065      debug="${compile.debug}"
2066      deprecation="${compile.deprecation}"
2067      optimize="${compile.optimize}"
2068      encoding="${compile.encoding}">
2069      <classpath refid="compile.classpath"/>
2070      <include name="org/greenstone/gsdl3/${axis.servicesname}${axis.sitename}.java" />
2071    </javac>
2072    <mkdir dir="${web.classes}/org/greenstone/gsdl3"/>
2073    <copy file="${build.home}/org/greenstone/gsdl3/${axis.servicesname}${axis.sitename}.class"
2074      tofile="${web.classes}/org/greenstone/gsdl3/${axis.servicesname}${axis.sitename}.class"
2075      overwrite="true" />
2076  </target>
2077 
2078
2079  <!-- ====================== Core targets ============================== -->
2080  <!-- core targets refer to the core gsdl3 java src -->
2081 
2082  <target name="prepare-core"/>
2083 
2084  <target name="configure-core"/>
2085
2086  <target name="update-core" depends="init,svnupdate-core,clean-core,compile-core"
2087    description="Update only the Greenstone core" />
2088 
2089  <target name="svnupdate-core" unless="nosvn.mode">
2090    <exec executable="svn">
2091      <arg value="update"/>
2092      <arg value="${basedir}"/>
2093      <arg value="-r"/><arg value="${branch.revision}"/>
2094    </exec>
2095  </target>
2096
2097  <target name="clean-core"
2098    description="Clean only the Greenstone core">
2099    <!-- should this delete the gsdl3.jar from web/WEB-INF?? -->
2100    <delete dir="${build.home}"/>
2101  </target>
2102
2103  <target name="compile-core" depends="init"
2104    description="Compile only the Greenstone core">
2105    <mkdir dir="${build.home}"/>
2106   
2107    <if><bool><isset property="with.jni"/></bool>
2108    <javac srcdir="${src.home}"
2109           destdir="${build.home}"
2110           includeantruntime="${compile.includeantruntime}"
2111           debug="${compile.debug}"
2112           deprecation="${compile.deprecation}"
2113           optimize="${compile.optimize}"
2114           encoding="${compile.encoding}">
2115      <classpath>
2116            <path refid="compile.classpath"/>
2117      </classpath>
2118    </javac>
2119    <else>
2120      <property name="gsprefix" value=""/>   
2121      <javac srcdir="${src.home}"
2122         destdir="${build.home}"
2123         includeantruntime="${compile.includeantruntime}"
2124         debug="${compile.debug}"
2125         deprecation="${compile.deprecation}"
2126         optimize="${compile.optimize}"
2127         encoding="${compile.encoding}">
2128        <classpath>
2129              <path refid="compile.classpath"/>
2130        </classpath>
2131        <exclude name="org/greenstone/gsdl3/service/GS2MGPPRetrieve.java"/>
2132        <exclude name="org/greenstone/gsdl3/service/GS2MGPPSearch.java"/>
2133        <exclude name="org/greenstone/gsdl3/service/GS2MGSearch.java"/>
2134        <exclude name="org/greenstone/gsdl3/service/GS2MGRetrieve.java"/>
2135        <exclude name="org/greenstone/gsdl3/service/GoogleNgramMGPPSearch.java"/>
2136        <exclude name="org/greenstone/gsdl3/service/PhindPhraseBrowse.java"/>
2137        <exclude name="org/greenstone/gsdl3/util/GDBMWrapper.java"/>
2138      </javac>
2139    </else>
2140    </if>
2141    <jar destfile="${build.home}/gsdl3.jar">
2142      <fileset dir="${build.home}">
2143        <include name="org/greenstone/gsdl3/**"/>
2144        <include name="org/flax/**"/>
2145        <exclude name="**/Test.class"/>
2146      </fileset>
2147      <manifest>
2148        <attribute name="Built-By" value="${user.name}" />
2149      </manifest>
2150    </jar>
2151    <copy file="${build.home}/gsdl3.jar" todir="${web.lib}"/>
2152
2153    <jar destfile="${build.home}/gutil.jar">
2154      <fileset dir="${build.home}">
2155        <include name="org/greenstone/util/**"/>
2156      </fileset>
2157      <manifest>
2158        <attribute name="Built-By" value="${user.name}" />
2159      </manifest>
2160    </jar>
2161    <copy file="${build.home}/gutil.jar" todir="${web.lib}"/>
2162
2163    <!-- copy the localsite server in case we need it -->
2164    <copy file="${build.home}/org/greenstone/gsdl3/${base.webservice.name}localsite.class" tofile="${web.classes}/org/greenstone/gsdl3/${base.webservice.name}localsite.class" />
2165
2166    <!-- Greenstone Administrator Interface -->
2167    <jar destfile="${build.home}/GAI.jar">
2168      <fileset dir="${build.home}">
2169        <include name="org/greenstone/admin/**"/>
2170      </fileset>
2171      <manifest>
2172        <attribute name="Built-By" value="${user.name}" />
2173      </manifest>
2174    </jar>
2175    <copy file="${build.home}/GAI.jar" todir="${web.lib}"/>
2176    <copy file="${build.home}/GAI.jar" todir="${admin.dir}"/>
2177    <jar destfile="${build.home}/phind.jar">
2178      <fileset dir="${build.home}">
2179        <include name="org/greenstone/applet/phind/**"/>
2180      </fileset>
2181      <manifest>
2182        <attribute name="Built-By" value="${user.name}" />
2183      </manifest>
2184    </jar>
2185    <mkdir dir="${web.applet}"/>
2186    <copy file="${build.home}/phind.jar" todir="${web.applet}"/>
2187    <!-- phind also needs xercesImpl.jar and xml-apis.jar to be in web/applet -->
2188    <if>
2189      <bool><istrue value="${tomcat.islocal}"/></bool>
2190      <if><bool><available file="${catalina.home}/lib/xercesImpl.jar"/></bool><!-- moved for solr -->
2191    <copy file="${catalina.home}/lib/xercesImpl.jar" todir="${web.applet}"/>
2192    <copy file="${catalina.home}/lib/xml-apis.jar" todir="${web.applet}"/>
2193   
2194    <else><!-- get from default GS3 web lib location-->
2195      <copy file="${web.lib}/xercesImpl.jar" todir="${web.applet}"/>
2196      <copy file="${web.lib}/xml-apis.jar" todir="${web.applet}"/>
2197    </else>
2198      </if>
2199    </if>
2200
2201
2202    <!-- skip anttasks for now
2203    <jar destfile="${build.home}/anttasks.jar">
2204      <fileset dir="${build.home}">
2205        <include name="org/greenstone/anttasks/**"/>
2206      </fileset>
2207      <manifest>
2208        <attribute name="Built-By" value="${user.name}" />
2209      </manifest>
2210    </jar>
2211    <copy file="${build.home}/anttasks.jar" todir="${basedir}/lib/java"/>-->
2212    <jar destfile="${build.home}/gsdl3test.jar">
2213      <fileset dir="${build.home}">
2214        <include name="org/greenstone/gsdl3/**/*Test.class"/>
2215        <include name="org/greenstone/testing/**"/>
2216      </fileset>
2217      <manifest>
2218        <attribute name="Built-By" value="${user.name}" />
2219      </manifest>
2220    </jar>
2221    <jar destfile="${build.home}/server.jar">
2222      <fileset dir="${build.home}">
2223        <include name="org/greenstone/server/**"/>
2224        <include name="org/greenstone/util/**"/>
2225      </fileset>
2226      <fileset file="${basedir}/resources/java/server.properties"/>
2227      <manifest>
2228        <attribute name="Built-By" value="${user.name}"/>
2229      </manifest>
2230    </jar>
2231    <copy file="${build.home}/server.jar" todir="${basedir}"/>
2232  </target>
2233
2234  <!-- === Eclipse targets == -->
2235  <target name="setup-for-eclipse">
2236
2237    <filter token="gsdlhome" value="${gs2build.home}"/>
2238    <filter token="gsdl3srchome" value="${basedir}"/>
2239    <filter token="gsdl3home" value="${basedir}/web"/>
2240
2241    <if>
2242      <bool><not><available file="${basedir}/TransformingLibrary.launch"/></not></bool>         
2243      <copy file="${basedir}/TransformingLibrary.launch.in" tofile="${basedir}/TransformingLibrary.launch" filtering="true" overwrite="true"/>
2244    </if>
2245<!--
2246    <if>
2247      <bool><not><available file="${basedir}/LibraryCommandline.launch"/></not></bool>         
2248      <copy file="${basedir}/LibraryCommandline.launch.in" tofile="${basedir}/LibraryCommandline.launch" filtering="true" overwrite="true"/>
2249    </if>
2250-->
2251  </target>
2252 
2253  <!-- ================== Packages targets ================================ -->
2254  <!-- these targets refer to the greenstone source packages - these need
2255  updating less often, so are in  separate targets to the core -->
2256  <target name="prepare-packages" depends="init"/>
2257 
2258  <target name="update-packages" depends="init,svnupdate-packages,configure-packages,clean-packages,compile-packages"
2259    description="Update only the source packages"/>
2260
2261  <target name="svnupdate-packages" unless="nosvn.mode">
2262    <exec executable="svn">
2263      <arg value="update"/>
2264      <arg value="${src.packages.home}"/>
2265      <arg value="-r"/><arg value="${branch.revision}"/>
2266    </exec>
2267  </target>
2268
2269 
2270  <target name="configure-packages" depends="init,configure-javagdbm"
2271    description="Configure only the packages."/>
2272 
2273  <target name="configure-javagdbm" if="with.jni">
2274    <echo>
2275      Configuring JavaGDBM
2276    </echo>
2277   
2278    <exec executable="${javagdbm.home}/configure" os="${os.unix}" dir="${javagdbm.home}" failonerror="true">
2279      <arg value="--prefix=${basedir}"/>
2280      <arg value="--libdir=${lib.jni}"/>
2281      <arg value="--with-gdbm=${gdbm.home}"/>
2282      <arg line="${cross.configure.args}"/>
2283    </exec>   
2284  </target>
2285
2286  <target name="clean-packages" depends="init,clean-javagdbm" description="Clean only the packages"/>
2287
2288  <target name="clean-javagdbm" depends="init">
2289    <if><bool><available file="${javagdbm.home}/Makefile"/></bool>
2290    <exec executable="make" os="${os.unix}"
2291      dir="${javagdbm.home}" failonerror="true">
2292      <arg value="clean"/>
2293    </exec>
2294    </if>
2295  </target>
2296 
2297  <target name="distclean-packages" depends="init,distclean-javagdbm" description="Distclean only the packages"/>
2298
2299  <target name="distclean-javagdbm" depends="init">
2300    <if><bool><available file="${javagdbm.home}/Makefile"/></bool>
2301    <exec executable="make" os="${os.unix}"
2302      dir="${javagdbm.home}" failonerror="true">
2303      <arg value="distclean"/>
2304    </exec>
2305    </if>
2306  </target>
2307 
2308  <target name="compile-packages" description="Compile only the source packages">
2309    <!-- javagdbm -->
2310    <antcall target="compile-javagdbm"/>
2311    <!-- Search4j -->
2312    <antcall target="compile-search4j"/>
2313  </target>
2314
2315  <target name="compile-javagdbm" description="Compile JavaGDBM" if="with.jni">
2316   
2317    <!-- unix: -->
2318    <echo>compile javagdbm</echo>
2319    <exec executable="make" os="${os.unix}" dir="${javagdbm.home}" failonerror="true">
2320      <arg value="JAVACOPTIONS=-encoding UTF8"/>
2321    </exec>
2322    <exec executable="make" os="${os.unix}" dir="${javagdbm.home}" failonerror="true">
2323      <arg value="install"/>
2324    </exec>
2325
2326    <!-- windows: Calling without the "compile" argument first will run winMake.bat with
2327         "all" which will then perform both the compile AND link targets in jni/win32.mak
2328         (thereby also generating gdbmjava.dll). Then we run the same command with
2329         the "install" argument to copy the gdbmjava.dll into the correct location. -->
2330    <echo>Windows: compile javagdbm</echo>
2331    <exec executable="${javagdbm.home}/winMake.bat" osfamily="windows" dir="${javagdbm.home}" failonerror="true">     
2332      <env key="GSDL3SRCHOME" path="${basedir}"/>
2333    </exec>
2334    <exec executable="${javagdbm.home}/winMake.bat" osfamily="windows" dir="${javagdbm.home}" failonerror="true">
2335      <env key="GSDL3SRCHOME" path="${basedir}"/>
2336      <arg value="install"/>
2337    </exec>
2338
2339    <!-- install the jar file -->
2340    <echo>Install the javagdbm jar file ${javagdbm.home}/javagdbm.jar ${lib.jni}</echo>
2341    <copy file="${javagdbm.home}/javagdbm.jar" todir="${lib.jni}"/>
2342  </target>
2343
2344  <target name="compile-search4j">
2345
2346    <!-- windows -->
2347    <if><bool><istrue value="${current.os.iswindows}"/></bool>
2348      <exec executable="nmake" dir="${src.packages.home}/search4j" failonerror="true">
2349        <arg value="/f"/>
2350        <arg value="win32.mak"/>
2351        <arg value='BINDIR="${basedir}\bin"'/>
2352      </exec>
2353      <exec executable="nmake" dir="${src.packages.home}/search4j" failonerror="true">
2354        <arg value="/f"/>
2355        <arg value="win32.mak"/>
2356        <arg value="install"/>
2357        <arg value='BINDIR="${basedir}\bin"'/>
2358      </exec>
2359
2360    <!-- unix -->
2361    <else><if><bool><istrue value="${current.os.isunix}"/></bool>
2362      <exec executable="${src.packages.home}/search4j/configure" dir="${src.packages.home}/search4j" failonerror="true">
2363        <arg value="--bindir=${basedir}/bin"/>
2364        <arg value="${static.arg}"/>
2365        <arg line="${cross.configure.args}"/>
2366      </exec>
2367      <exec executable="make" dir="${src.packages.home}/search4j" failonerror="true"/>
2368      <exec executable="make" dir="${src.packages.home}/search4j" failonerror="true">
2369        <arg value="install"/>
2370      </exec>
2371
2372    <!-- else warn -->
2373    <else>
2374      <fail>this target does not support the current os</fail>
2375
2376    </else></if></else></if>
2377
2378  </target>
2379
2380  <target name="install-auxiliary-jar-files" depends="init">
2381
2382    <if>
2383      <bool><available file="${mg.home}/mg.jar"/></bool>
2384      <copy file="${mg.home}/mg.jar" todir="${lib.jni}"/>
2385    </if>
2386
2387    <if>
2388      <bool><available file="${mgpp.home}/mgpp.jar"/></bool>
2389      <copy file="${mgpp.home}/mgpp.jar" todir="${lib.jni}"/>
2390    </if>
2391
2392    <copy file="${lucene.home}/LuceneWrapper4.jar" todir="${web.lib}"/>   
2393  </target>
2394 
2395  <target name="install-jni-files" depends="init" if="with.jni">
2396    <antcall target="install-jni-files-linux"/>
2397    <antcall target="install-jni-files-windows"/>
2398    <antcall target="install-jni-files-macos"/>
2399  </target>
2400
2401  <target name="install-jni-files-linux" depends="init" if="current.os.isunixnotmac">
2402
2403    <if>
2404
2405      <bool><equals arg1="${os.bin.dir}" arg2="windows"/></bool>
2406      <!-- cross compiling to windows -->
2407      <copy file="${mg.home}/jni/mgretrievejni.dll" todir="${lib.jni}"/>
2408      <copy file="${mg.home}/jni/mgsearchjni.dll" todir="${lib.jni}"/>
2409      <copy file="${mg.home}/jni/mgpassjni.dll" todir="${lib.jni}"/>
2410      <copy file="${mgpp.home}/jni/mgppretrievejni.dll" todir="${lib.jni}"/>
2411      <copy file="${mgpp.home}/jni/mgppsearchjni.dll" todir="${lib.jni}"/>
2412      <copy file="${mgpp.home}/jni/mgpppassjni.dll" todir="${lib.jni}"/>
2413     
2414      <else>
2415    <!-- otherwise do the usual Unix copies -->
2416    <copy file="${mg.home}/jni/libmgretrievejni.so" todir="${lib.jni}"/>
2417    <copy file="${mg.home}/jni/libmgsearchjni.so" todir="${lib.jni}"/>
2418    <copy file="${mg.home}/jni/libmgpassjni.so" todir="${lib.jni}"/>
2419    <copy file="${mgpp.home}/jni/libmgppretrievejni.so" todir="${lib.jni}"/>
2420    <copy file="${mgpp.home}/jni/libmgppsearchjni.so" todir="${lib.jni}"/>
2421    <copy file="${mgpp.home}/jni/libmgpppassjni.so" todir="${lib.jni}"/>
2422      </else>
2423    </if>
2424
2425
2426  </target>
2427  <target name="install-jni-files-windows" depends="init" if="current.os.iswindows">
2428    <copy file="${mg.home}/jni/mgretrievejni.dll" todir="${lib.jni}"/>
2429    <copy file="${mg.home}/jni/mgsearchjni.dll" todir="${lib.jni}"/>
2430    <copy file="${mg.home}/jni/mgpassjni.dll" todir="${lib.jni}"/>
2431    <copy file="${mgpp.home}/jni/mgppretrievejni.dll" todir="${lib.jni}"/>
2432    <copy file="${mgpp.home}/jni/mgppsearchjni.dll" todir="${lib.jni}"/>
2433    <copy file="${mgpp.home}/jni/mgpppassjni.dll" todir="${lib.jni}"/>
2434  </target>
2435  <target name="install-jni-files-macos" depends="init" if="current.os.ismac">
2436    <copy file="${mg.home}/jni/libmgretrievejni.jnilib" todir="${lib.jni}"/>
2437    <copy file="${mg.home}/jni/libmgsearchjni.jnilib" todir="${lib.jni}"/>
2438    <copy file="${mg.home}/jni/libmgpassjni.jnilib" todir="${lib.jni}"/>
2439    <copy file="${mgpp.home}/jni/libmgppretrievejni.jnilib" todir="${lib.jni}"/>
2440    <copy file="${mgpp.home}/jni/libmgppsearchjni.jnilib" todir="${lib.jni}"/>
2441    <copy file="${mgpp.home}/jni/libmgpppassjni.jnilib" todir="${lib.jni}"/>
2442  </target>
2443 
2444  <!-- ========common-src targets =================================-->
2445  <!-- these are used to get common-src (for indexers, gdbm, sqlite etc) when
2446  collection building is not enabled -->
2447
2448  <target name="update-common-src" depends="init" if="collection.building.disabled">
2449  </target>
2450
2451  <target name="svnupdate-common-src" depends="init" if="collection.building.disabled" unless="nosvn.mode">
2452    <exec executable="svn">
2453      <arg value="update"/>
2454      <arg value="${common.src.home}"/>
2455      <arg value="-r"/><arg value="${branch.revision}"/>
2456    </exec>
2457  </target>
2458
2459  <target name="prepare-common-src" depends="init" if="collection.building.disabled" unless="common.src.present">
2460    <antcall target="checkout-common-src"/>
2461    <antcall target="unzip-windows-packages"/>
2462  </target>
2463
2464  <target name="checkout-common-src" depends="init" if="collection.building.disabled" unless="nosvn.mode">
2465    <echo>checking out common-src</echo>
2466    <exec executable="svn">
2467      <arg value="checkout"/>
2468      <arg value="${svn.root}/main/${branch.path}/greenstone2/common-src"/>
2469            <arg value="common-src"/>
2470      <arg value="-r"/><arg value="${branch.revision}"/>
2471    </exec>
2472  </target>
2473   
2474  <target name="configure-common-src" depends="init">
2475<!--
2476    <echo>cross configure args: ${cross.configure.args}</echo>
2477-->
2478    <exec executable="${common.src.home}/configure" os="${os.unix}"
2479      dir="${common.src.home}" failonerror="true">
2480      <arg value="--prefix=${gs2build.home}"/> <!-- what value to use?? -->
2481      <arg value="--bindir=${gs2build.home}/bin/${os.bin.dir}"/> <!-- what value to use?? -->
2482      <arg line="${gs2.opt.args}"/>
2483      <arg line="${static.arg}"/>
2484      <arg line="${cross.configure.args}"/>
2485      <arg line="${allargs}"/>
2486    </exec>
2487  </target>
2488
2489  <target name="clean-common-src" depends="init">
2490    <!-- unix:  -->
2491    <if><bool><available file="${common.src.home}/Makefile"/></bool>
2492    <exec executable="make" os="${os.unix}" dir="${common.src.home}" failonerror="true">
2493      <arg value="clean"/>
2494    </exec>
2495    </if>
2496    <!-- windows: -->   
2497    <exec executable="nmake" dir="${common.src.home}" osfamily="windows" failonerror="true">
2498      <arg value="/f"/>
2499      <arg value="win32.mak"/>
2500      <arg value="clean"/>
2501      <arg value="GSDLHOME=${gs2build.home}"/>
2502    </exec>
2503  </target>
2504  <target name="distclean-common-src" depends="init">
2505    <!-- unix:  -->
2506    <if><bool><available file="${common.src.home}/Makefile"/></bool>
2507    <exec executable="make" os="${os.unix}" dir="${common.src.home}" failonerror="true">
2508      <arg value="distclean"/>
2509    </exec>
2510    </if>
2511    <!-- windows: distclean = clean + remove configure products (remove makefiles). But on Windows there is no removing makefiles, so we just call clean -->   
2512    <exec executable="nmake" dir="${common.src.home}" osfamily="windows" failonerror="true">
2513      <arg value="/f"/>
2514      <arg value="win32.mak"/>
2515      <arg value="clean"/>
2516      <arg value="GSDLHOME=${gs2build.home}"/>
2517    </exec>
2518  </target>
2519  <target name="compile-common-src" depends="init">
2520    <!-- unix: -->
2521    <exec executable="make" os="${os.unix}" dir="${common.src.home}" failonerror="true">
2522      <arg value="${gs2.compile.target}"/>
2523    </exec>
2524    <!-- windows: -->
2525    <exec executable="nmake" dir="${common.src.home}" osfamily="windows" failonerror="true">
2526      <arg value="/f"/>
2527      <arg value="win32.mak"/>
2528      <arg value="GSDLHOME=${gs2build.home}"/>
2529      <arg value="ENABLE_JNI=${gs2.windows.enablejni}"/>
2530      <arg value="ENABLE_MG=${gs2.windows.enablemg}"/>
2531      <arg value="ENABLE_MGPP=${gs2.windows.enablemgpp}"/>
2532      <arg value="USE_GDBM=${gs2.windows.usegdbm}"/>
2533      <arg value="USE_SQLITE=${gs2.windows.usesqlite}"/>
2534    </exec>
2535  </target>
2536 
2537  <!-- ======= collection-building targets ===========================-->
2538
2539  <target name="update-collection-building" if="collection.building.enabled"
2540    depends="init,svnupdate-collection-building,gs2build-edit-setup-bat,configure-common-src,clean-common-src,compile-common-src,configure-collection-building,clean-collection-building,compile-collection-building"
2541    description="Update (SVN update, configure, compile etc) only the collection building components"/>
2542
2543  <target name="svnupdate-collection-building" if="collection.building.enabled" depends="init,svnupdate-gs2build,svnupdate-cgi,svnupdate-gli" unless="nosvn.mode"
2544    description="SVN update the collection building components">
2545  </target>
2546
2547  <target name="prepare-collection-building" depends="init,prepare-gs2build,svnupdate-cgi,prepare-gli" if="collection.building.enabled">
2548  </target>
2549
2550  <target name="configure-collection-building" depends="init,configure-build-src" if="collection.building.enabled"
2551    description="Configure the collection building components">
2552  </target>
2553
2554  <target name="clean-collection-building" depends="init,clean-gli,clean-build-src"
2555    description="Clean only the collection building components"
2556    if="collection.building.enabled"/>
2557
2558  <target name="distclean-collection-building" depends="init,clean-build-src,distclean-build-src"
2559    description="Distclean only the collection building components"
2560    if="collection.building.enabled"/>
2561
2562  <target name="compile-collection-building" depends="init,compile-build-src,compile-gli" if="collection.building.enabled"
2563    description="Compile only the collection building components">
2564    <!-- make install for common-src -->
2565    <!-- unix: -->
2566    <exec executable="make" os="${os.unix}" dir="${common.src.home}" failonerror="true">
2567      <arg value="${gs2.install.target}"/>
2568    </exec>
2569     
2570    <!-- windows: -->
2571    <exec executable="nmake" dir="${common.src.home}" osfamily="windows" failonerror="true">
2572      <arg value="/f"/>
2573      <arg value="win32.mak"/>
2574      <arg value="install"/>
2575      <arg value="GSDLHOME=${gs2build.home}"/>
2576      <arg value="ENABLE_JNI=${gs2.windows.enablejni}"/>
2577      <arg value="ENABLE_MG=${gs2.windows.enablemg}"/>
2578      <arg value="ENABLE_MGPP=${gs2.windows.enablemgpp}"/>
2579      <arg value="USE_GDBM=${gs2.windows.usegdbm}"/>
2580      <arg value="USE_SQLITE=${gs2.windows.usesqlite}"/>
2581      <!--
2582      <arg value="ENABLE_JNI=${gs2.windows.enablejni}"/>
2583      <arg value="USE_SQLITE=0"/>--> <!-- why is this not on by default? -->
2584    </exec>
2585
2586    <!-- install gs2build indexers for windows -->
2587      <if>
2588    <bool><istrue value="${current.os.iswindows}"/></bool>
2589    <copy todir="${gs2build.home}/bin/windows">
2590      <fileset dir="${gs2build.home}/common-src/indexers/bin">
2591        <include name="*.*"/>
2592      </fileset>
2593    </copy>
2594      </if>
2595
2596    <!-- LuceneWrapper jar file not installed by default -->
2597    <mkdir dir="${gs2build.home}/bin/java"/>
2598    <copy file="${lucene.home}/LuceneWrapper4.jar" todir="${gs2build.home}/bin/java"/>
2599
2600  </target>
2601
2602  <!-- ============== gli targets ================================= -->
2603 
2604  <!-- gliserver.pl, gsdlCGI.pm, metadata-server.pl and checksum.pl are updated alongside
2605       this in target svnupdate-collection-building -->
2606  <target name="svnupdate-gli" if="collection.building.enabled" depends="init" unless="nosvn.mode">
2607
2608    <exec executable="svn">
2609      <arg value="update"/>
2610      <arg value="${gli.home}"/>
2611      <arg value="-r"/><arg value="${branch.revision}"/>
2612    </exec>
2613
2614  </target>
2615
2616  <!-- gliserver.pl, gsdlCGI.pm, metadata-server.pl and checksum.pl are updated
2617       alongside this prepare-gli target in target prepare-collection-building -->
2618  <target name="prepare-gli" depends="init" if="collection.building.enabled" unless="gli.present">
2619    <!-- checkout -->
2620    <if><bool><and><not><istrue value="${nosvn.mode}"/></not><isset property="with.gli.and.gems"/></and></bool>
2621
2622    <exec executable="svn">
2623      <arg value="checkout"/>
2624      <arg value="${svn.root}/main/${branch.path}/gli"/>
2625      <arg value="-r"/><arg value="${branch.revision}"/>
2626    </exec>
2627
2628    </if>
2629  </target>
2630
2631  <!-- svn checkout gliserver.pl, gsdlCGI.pm for gli applet, as well as gsdlCGI.pm-dependent metadata-server.pl
2632       (checksum.pl is used by GS2 for depositdspace.dm and may eventually be used by GS3 too) -->
2633  <target name="svnupdate-cgi">
2634
2635    <exec executable="svn" dir="web/WEB-INF/cgi">
2636      <arg value="export"/>
2637      <arg value="-r"/><arg value="${branch.revision}"/>
2638      <arg value="${svn.root}/main/${branch.path}/greenstone2/common-src/cgi-bin/gliserver.pl"/>
2639    </exec>
2640    <exec executable="svn" dir="web/WEB-INF/cgi">
2641      <arg value="export"/>
2642      <arg value="-r"/><arg value="${branch.revision}"/>
2643      <arg value="${svn.root}/main/${branch.path}/greenstone2/common-src/cgi-bin/gsdlCGI.pm"/>
2644    </exec>
2645    <exec executable="svn" dir="web/WEB-INF/cgi">
2646      <arg value="export"/>
2647      <arg value="-r"/><arg value="${branch.revision}"/>
2648      <arg value="${svn.root}/main/${branch.path}/greenstone2/common-src/cgi-bin/metadata-server.pl"/>
2649    </exec>
2650    <exec executable="svn" dir="web/WEB-INF/cgi">
2651      <arg value="export"/>
2652      <arg value="-r"/><arg value="${branch.revision}"/>
2653      <arg value="${svn.root}/main/${branch.path}/greenstone2/common-src/cgi-bin/checksum.pl"/>
2654    </exec>
2655  </target>
2656
2657 
2658  <target name="clean-gli" depends="init" if="collection.building.enabled">
2659    <!-- gli -->
2660    <property name="gli.home" value="${basedir}/gli"/>
2661    <!-- linux -->
2662    <exec executable="clean.sh" os="${os.unix}" dir="${gli.home}"
2663      resolveExecutable="true" failonerror="true"/>
2664    <!-- windows -->
2665    <exec executable="clean.bat" osfamily="windows" dir="${gli.home}"
2666      resolveExecutable="true" failonerror="true"/>
2667  </target>
2668 
2669  <target name="compile-gli" depends="init" if="collection.building.enabled">
2670    <if><bool><isset property="with.gli.and.gems"/></bool>
2671      <!-- gli -->
2672      <property name="gli.home" value="${basedir}/gli"/>
2673
2674      <!-- linux -->
2675      <exec executable="makegli.sh" os="${os.unix}" dir="${gli.home}" resolveExecutable="true" failonerror="true"/>
2676      <!--remote gli-->
2677      <exec executable="makejar.sh" os="${os.unix}" dir="${gli.home}"
2678        resolveExecutable="true" failonerror="true"/>
2679      <!-- windows -->
2680      <exec executable="makegli.bat" osfamily="windows" dir="${gli.home}" resolveExecutable="true" failonerror="true"/>
2681      <!--remote gli-->
2682      <exec executable="makejar.bat" osfamily="windows" dir="${gli.home}"
2683        resolveExecutable="true" failonerror="true"/>
2684      <copy file="${gli.home}/GLIServer.jar" todir="${gs2build.home}/bin/java" />
2685    </if>
2686  </target>
2687
2688  <target name="gli" description="Run the Greenstone Librarian Interface" depends="init" if="collection.building.enabled">
2689    <exec executable="${basedir}/gli/gli.sh" os="${os.linux},${os.solaris}" dir="${basedir}/gli" spawn="true">
2690      <env key="gsdl3path" path="${basedir}"/>
2691      <env key="gsdlpath" path="${gs2build.home}"/>
2692    </exec>
2693    <exec executable="${basedir}/gli/gli.sh" os="${os.mac}" dir="${basedir}/gli" spawn="true">
2694      <env key="gsdl3path" path="${basedir}"/>
2695      <env key="gsdlpath" path="${gs2build.home}"/>
2696      <env key="DYLD_LIBRARY_PATH" path="${env.DYLD_LIBRARY_PATH}:${gdbm.home}/lib"/>
2697    </exec>
2698    <exec executable="${basedir}/gli/gli.bat" osfamily="windows" dir="${basedir}/gli" spawn="true">
2699      <env key="GSDL3PATH" path="${basedir}"/>
2700      <env key="GSDLPATH" path="${gs2build.home}"/>
2701    </exec>
2702    <echo>Running GLI from Ant means that you don't get to see any of the terminal output. If you have problems with GLI and want to see the output, please run the script gli.sh/bat from the greenstone3/gli directory.
2703    </echo>
2704  </target>
2705
2706  <!-- ================ gs2build targets =========================== -->
2707
2708  <target name="svnupdate-gs2build" if="collection.building.enabled" depends="init" unless="nosvn.mode">
2709    <echo>svn updating gs2build</echo>
2710    <exec executable="svn">
2711      <arg value="update"/>
2712      <arg value="${gs2build.home}"/>
2713      <arg value="-r"/><arg value="${branch.revision}"/>
2714    </exec>
2715  </target>
2716   
2717  <target name="prepare-gs2build" depends="init" if="collection.building.enabled" unless="gs2build.present">
2718    <antcall target="checkout-gs2build"/>
2719    <antcall target="prepare-pdfbox"/>
2720    <antcall target="prepare-imagemagick"/> <!-- has to be done before calling prepare-gnome-lib -->
2721    <antcall target="prepare-gnome-lib"/>
2722    <antcall target="unzip-windows-packages"/>
2723    <antcall target="checkout-winbin"/>
2724    <antcall target="get-windows-binaries"/>
2725    <antcall target="delete-winbin"/>
2726  </target>
2727
2728  <target name="checkout-gs2build" depends="init" if="collection.building.enabled" unless="nosvn.mode">
2729    <echo>checking out gs2build</echo>
2730    <exec executable="svn">
2731      <arg value="checkout"/>
2732      <arg value="${svn.root}/main/${branch.path}/gs2build"/>
2733      <arg value="-r"/><arg value="${branch.revision}"/>
2734    </exec>
2735  </target>
2736
2737  <!-- Gets the PDFBox extension into gs2build/ext if checkout.pdfbox.ext is set to true in build.properties
2738       (which it is by default) -->
2739  <target name="prepare-pdfbox" depends="init" if="collection.building.enabled">
2740    <if>
2741      <bool>
2742    <istrue value="${checkout.pdfbox.ext}"/>
2743      </bool>
2744     
2745      <property name="pdfbox.ext.dir" value="${gs2build.home}/ext/pdf-box"/>
2746      <condition property="pdfbox.ext.present">
2747    <available file="${pdfbox.ext.dir}" type="dir" />
2748      </condition>
2749     
2750      <!-- get the pdfbox tar.gz file if we don't already have it and extract it if there's no pdf-box directory in gs2build/ext-->
2751      <if>
2752    <bool>
2753      <not><istrue value="${pdfbox.ext.present}"/></not>
2754    </bool>
2755
2756    <if>
2757      <bool>
2758        <not><istrue value="${gs2build.home}/ext/pdf-box-java.tar.gz"/></not>
2759      </bool>
2760
2761      <echo>Checking out the PDFBox extension into the GSDLHOME extension area</echo>
2762      <exec executable="svn">
2763        <arg value="export"/>
2764        <arg value="${svn.root}/gs2-extensions/pdf-box/trunk/pdf-box-java.tar.gz"/>
2765        <arg value="${gs2build.home}/ext/pdf-box-java.tar.gz"/>
2766      </exec>
2767    </if>   
2768
2769    <echo>Extacting the PDFBox extension into the GSDLHOME extension area</echo>
2770    <untar compression="gzip"
2771           src="${gs2build.home}/ext/pdf-box-java.tar.gz"
2772           dest="${gs2build.home}/ext"/>
2773
2774    <delete file="${gs2build.home}/ext/pdf-box-java.tar.gz"/>
2775
2776    <else>
2777      <echo>The PDFBox extension already exists at ${pdfbox.ext.dir}</echo>
2778    </else>
2779      </if>
2780
2781      <else>
2782    <echo>**** Not preparing the PDFBox extension:</echo>
2783    <echo>The property checkout.pdfbox.ext in build.properties was not set or was set to false</echo>
2784      </else>
2785    </if>
2786  </target>
2787
2788  <target name="prepare-imagemagick" depends="init" if="collection.building.enabled">
2789    <if>
2790      <bool>
2791    <istrue value="${checkout.imagemagick.ext}"/>
2792      </bool>
2793
2794      <antcall target="checkout-imagemagick"/>
2795      <!--Compilation of imagemagick now happens during ant install, still before configuring the src code, as before -->
2796
2797      <else>
2798    <echo>**** Not preparing imagemagick:</echo>
2799    <echo>property checkout.imagemagick.ext in build.properties was not set or was set to false</echo>
2800      </else>
2801    </if>
2802  </target>
2803
2804  <target name="checkout-imagemagick" depends="init" if="collection.building.enabled" unless="nosvn.mode">
2805   
2806    <property name="imagemagick.src.dir" value="${gs2build.home}/ext/imagemagick"/>
2807    <condition property="imagemagick.src.present">
2808      <available file="${imagemagick.src.dir}" type="dir" />
2809    </condition>
2810
2811    <if>
2812      <bool>
2813    <not><istrue value="${imagemagick.src.present}"/></not>
2814      </bool>
2815     
2816      <echo>checking out imagemagick source into the extension area</echo>
2817
2818      <exec executable="svn">
2819    <arg value="checkout"/>
2820    <arg value="${svn.root}/gs2-extensions/imagemagick/trunk/src"/>
2821    <arg value="${imagemagick.src.dir}"/>
2822      </exec>
2823
2824      <else>
2825    <echo>imagemagick source code already exists at ${imagemagick.src.dir}</echo>
2826      </else>
2827    </if>
2828  </target>
2829
2830 <!-- Compile up imagemagick src folder if: the checkout.imagemagick.ext flag is turned on, if the imagick source code exists and if hasn't already been compiled up, then compile it up. Later can check if a gs-specific binary version has been installed already, in which case compilation won't be necessary. -->
2831  <target name="compile-imagemagick" if="checkout.imagemagick.ext">
2832   
2833    <property name="imagemagick.src.dir" value="${gs2build.home}/ext/imagemagick"/>
2834    <property name="imagemagick.compiled.dir" value="${gs2build.home}/ext/imagemagick/${os.bin.dir}"/>
2835
2836    <condition property="imagemagick.src.present.firstcheck">
2837      <available file="${imagemagick.src.dir}" type="dir" />
2838    </condition>
2839    <condition property="imagemagick.compiled.present">
2840      <available file="${imagemagick.compiled.dir}" type="dir"/>
2841    </condition>
2842    <!--<condition property="imagemagick.bin.present">
2843      <available file="${basedir}/wherever/the/imgmagick/binary/is/to/be/found" type="dir" />
2844    </condition>-->
2845
2846    <!-- imagemagick will only be checked out if the user set the checkout.imagemagick.ext in build.properties -->
2847    <if>
2848      <bool>
2849    <isfalse value="${imagemagick.src.present.firstcheck}"/>
2850      </bool>
2851      <antcall target="checkout-imagemagick"/>
2852    </if>
2853
2854    <!-- keep track of whether the imagemagick src is now indeed present. Need to know this for a subsequent test -->
2855    <condition property="imagemagick.src.present">
2856      <available file="${imagemagick.src.dir}" type="dir" />
2857    </condition>
2858
2859    <if>
2860      <bool>
2861    <and>
2862      <istrue value="${imagemagick.src.present}"/> <!-- imagemagick src code is present -->
2863      <isfalse value="${imagemagick.compiled.present}"/> <!-- imagemagick src not compiled yet, so no imagemagick/os subfolder yet -->
2864    </and>
2865      </bool>
2866      <!-- then compile it. Only necessary for mac/linux, since windows has a stable working binary of imagemagick -->
2867      <exec executable="/bin/bash" dir="${imagemagick.src.dir}" failonerror="true">
2868        <arg value="CASCADE-MAKE.sh"/>
2869      </exec> 
2870    </if>
2871  </target>
2872
2873
2874  <!-- Compile up gnome-lib src folder if: checkout.gnomelib.ext is turned on, and if not using the binary
2875       version (gnome-lib-minimal), and if the gnome-lib src folder is not already compiled up. -->
2876  <target name="compile-gnome-lib" if="checkout.gnomelib.ext">
2877
2878    <!-- http://stackoverflow.com/questions/3290307/sourcing-a-shell-profile-in-an-ant-build-file
2879     TODO: CASCADE-MAKE already sources devel.bash, but we still want to source it more globally,
2880     so that the rest of the GS3 compilation process also has access to those env variables -->
2881   
2882    <property name="gnome.lib.src.dir" value="${basedir}/gs2build/ext/gnome-lib"/>
2883    <property name="gnome.lib.compiled.dir" value="${basedir}/gs2build/ext/gnome-lib/${os.bin.dir}"/>
2884
2885    <condition property="gnome.src.lib.present.firstcheck" value="true" else="false">
2886      <available file="${gnome.lib.src.dir}" type="dir" />
2887    </condition>
2888    <condition property="gnome.compiled.lib.present" value="true" else="false">
2889      <available file="${gnome.lib.compiled.dir}" type="dir"/>
2890    </condition>
2891    <condition property="gnome.lib.min.present" value="true" else="false">
2892      <available file="${basedir}/gs2build/ext/gnome-lib-minimal" type="dir" />
2893    </condition>
2894
2895    <!-- Make sure to checkout gnome-lib if it was not checked out at this stage
2896     since we're instructed to do so in th pre-condition to this target -->
2897    <if>
2898      <bool>
2899    <and>
2900      <isfalse value="${gnome.lib.min.present}"/>
2901      <isfalse value="${gnome.src.lib.present.firstcheck}"/>
2902    </and>
2903      </bool>
2904      <antcall target="checkout-gnome-lib"/>
2905    </if>
2906
2907    <!-- Keep track of whether we have the gnome-lib src folder now. Need to know this for a subsequent test -->
2908    <condition property="gnome.src.lib.present" value="true" else="false">
2909      <available file="${gnome.lib.src.dir}" type="dir" />
2910    </condition>
2911
2912    <!--<echo>MIN: ${gnome.lib.min.present}
2913      SRC LIB: ${gnome.src.lib.present}
2914      COMPILED: ${gnome.compiled.lib.present}</echo>-->
2915
2916    <if>
2917      <bool>
2918    <and>
2919      <isfalse value="${gnome.lib.min.present}"/> <!-- no gnome-lib-minimal binary present -->
2920      <istrue value="${gnome.src.lib.present}"/> <!-- gnome-lib folder for compilation is present-->
2921      <isfalse value="${gnome.compiled.lib.present}"/> <!-- gnome-lib not yet compiled, so no gnome-lib/os subfolder yet -->
2922    </and>
2923      </bool>
2924
2925      <!-- then compile it. Only necessary for mac/linux, since windows doesn't need gnome lib -->
2926      <exec executable="/bin/bash" dir="${gnome.lib.src.dir}" failonerror="true">
2927        <arg value="CASCADE-MAKE.sh"/>
2928      </exec> 
2929    </if>
2930  </target>
2931
2932
2933  <target name="prepare-gnome-lib" depends="init" if="collection.building.enabled" unless="gnome-lib.present">
2934    <if>
2935      <bool>
2936    <istrue value="${checkout.gnomelib.ext}"/>
2937      </bool>
2938
2939      <antcall target="checkout-gnome-lib"/>
2940      <!--Compilation of gnome-lib happens during ant install, just before configuring (common-src and) build-src-->
2941
2942      <else>
2943    <echo>**** Not preparing gnome-lib:</echo>
2944    <echo>property checkout.gnomelib.ext in build.properties was not set or was set to false</echo>
2945      </else>
2946    </if>
2947  </target>
2948
2949
2950  <target name="checkout-gnome-lib" depends="init" if="collection.building.enabled" unless="nosvn.mode">
2951
2952    <property name="gnomelib.src.dir" value="${basedir}/gs2build/ext/gnome-lib"/>
2953    <condition property="gnome.src.present">
2954      <available file="${gnomelib.src.dir}" type="dir" />
2955    </condition>
2956
2957    <if>
2958      <bool>
2959    <not><istrue value="${gnome.src.present}"/></not>
2960      </bool>
2961
2962      <echo>checking out gnome-lib extension</echo>
2963      <exec executable="svn">
2964    <arg value="checkout"/>
2965    <arg value="${svn.root}/gs2-extensions/gnome-lib/trunk/src"/>
2966    <arg value="${gs2build.home}/ext/gnome-lib"/>
2967      </exec>
2968
2969      <else>
2970    <echo>gnomelib source code already exists at ${gnomelib.src.dir}</echo>
2971      </else>
2972    </if>
2973
2974  </target>
2975
2976  <target name="checkout-winbin" depends="init" if="current.os.iswindows"
2977    unless="nosvn.mode">
2978
2979    <exec executable="svn">
2980      <arg value="checkout"/>
2981      <arg value="${svn.root}/main/${branch.path}/binaries/windows"/>
2982      <arg value="-r"/><arg value="${branch.revision}"/>
2983      <arg value="winbin"/>
2984    </exec>
2985
2986  </target>
2987
2988  <target name="update-winbin" depends="init" if="current.os.iswindows" unless="nosvn.mode">
2989    <exec executable="svn">
2990      <arg value="update"/>
2991      <arg value="winbin"/>
2992      <arg value="-r"/><arg value="${branch.revision}"/>
2993    </exec>
2994
2995  </target>
2996 
2997  <target name="get-windows-binaries" depends="init" if="collection.building.enabled.windows">
2998    <move todir="${gs2build.home}/bin/windows" failonerror="false">
2999      <fileset dir="${basedir}/winbin/bin"/>
3000    </move>
3001  </target>
3002
3003  <target name="delete-winbin" depends="init" if="collection.building.enabled.windows">
3004    <delete dir="${basedir}/winbin"/>
3005  </target>
3006 
3007  <target name="unzip-windows-packages" depends="init" if="current.os.iswindows"> 
3008    <unzip src="${common.src.home}/packages/windows/crypt/crypt.zip"
3009      dest="${common.src.home}/packages/windows/crypt"/>
3010    <untar compression="gzip"
3011      src="${common.src.home}/packages/sqlite/${sqlite.targz.version}"
3012      dest="${common.src.home}/packages/sqlite"/>
3013    <unzip src="${common.src.home}/indexers/packages/windows/iconv/iconv.zip"
3014      dest="${common.src.home}/indexers/packages/windows/iconv"/>
3015  </target>
3016   
3017  <target name="gs2build-edit-setup-bat" if="collection.building.enabled.windows">
3018    <!-- we want a windows path in the setup.bat file -->
3019    <pathconvert targetos="windows" property="gs2build.home.windows">
3020      <path path="${gs2build.home}"/>
3021    </pathconvert>
3022    <move file="${gs2build.home}/setup.bat" tofile="${gs2build.home}/setup-tmp.bat">
3023      <filterset>
3024        <filter token="gsdlhome" value="${gs2build.home.windows}"/>
3025      </filterset>
3026    </move> 
3027    <move file="${gs2build.home}/setup-tmp.bat" tofile="${gs2build.home}/setup.bat" />
3028  </target>
3029 
3030 
3031  <target name="clean-build-src" depends="init" if="collection.building.enabled">
3032    <!-- unix:  -->
3033    <if><bool><available file="${build.src.home}/Makefile"/></bool>
3034    <exec executable="make" os="${os.unix}" dir="${build.src.home}" failonerror="true">
3035      <arg value="clean"/>
3036    </exec>
3037    </if>
3038    <!-- windows: -->   
3039    <exec executable="nmake" dir="${build.src.home}" osfamily="windows" failonerror="true">
3040      <arg value="/f"/>
3041      <arg value="win32.mak"/>
3042      <arg value="clean"/>
3043      <arg value="GSDLHOME=${gs2build.home}"/>
3044    </exec>
3045  </target>
3046 
3047 
3048  <target name="distclean-build-src" depends="init,clean-build-src" if="collection.building.enabled">
3049    <!-- unix:  -->
3050    <if><bool><available file="${build.src.home}/Makefile"/></bool>
3051    <exec executable="make" os="${os.unix}" dir="${build.src.home}" failonerror="true">
3052      <arg value="distclean"/>
3053    </exec>
3054    </if>
3055    <!-- windows: distclean = clean + remove configure products (remove makefiles). But on Windows there is no removing makefiles, so we just call clean -->   
3056    <exec executable="nmake" dir="${build.src.home}" osfamily="windows" failonerror="true">
3057      <arg value="/f"/>
3058      <arg value="win32.mak"/>
3059      <arg value="clean"/>
3060      <arg value="GSDLHOME=${gs2build.home}"/>
3061    </exec>
3062  </target>
3063 
3064  <target name="configure-build-src" depends="init" if="collection.building.enabled"
3065    description="Configure the build-src component">
3066    <exec executable="${build.src.home}/configure" os="${os.unix}"
3067      dir="${build.src.home}" failonerror="true">
3068      <arg value="--prefix=${gs2build.home}"/>
3069      <arg line="${gs2.opt.args} ${static.arg} ${cross.configure.args} ${allargs}"/>
3070    </exec>
3071  </target>
3072
3073  <!-- common-src is done separately and needs to be compiled first -->
3074  <target name="compile-build-src" depends="init" if="collection.building.enabled">
3075   
3076    <exec executable="make" dir="${build.src.home}" os="${os.unix}" failonerror="true">
3077        <arg line="${ldlpath.arg}"/>
3078    </exec>
3079   
3080    <exec executable="make" dir="${build.src.home}" os="${os.unix}" failonerror="true">
3081      <arg value="install"/>
3082    </exec>
3083
3084    <!-- run the setup script -->
3085    <!-- <exec executable="${compile.windows.c++.setup}" osfamily="windows" failonerror="true"/>-->
3086      <!--Above does not work: even though vcvars.bat executes, the env changes it makes don't get saved. Need user to run vcvars.bat first before calling ant-->
3087      <exec executable="nmake" dir="${build.src.home}" osfamily="windows" failonerror="true">
3088        <arg value="/f"/>
3089        <arg value="win32.mak"/>
3090    <arg value="GSDLHOME=${gs2build.home}"/>
3091      </exec>
3092      <exec executable="nmake" dir="${build.src.home}" osfamily="windows" failonerror="true">
3093        <arg value="/f"/>
3094        <arg value="win32.mak"/>
3095        <arg value="install"/>
3096    <arg value="GSDLHOME=${gs2build.home}"/>
3097      </exec>
3098  </target>
3099 
3100
3101  <!-- ======================== TESTING Targets ========================= -->
3102 
3103  <target name="test" description="Run the (incomplete) JUnit test suite "
3104    depends="init">
3105    <mkdir dir="${basedir}/test"/>
3106    <junit printsummary="withOutAndErr"
3107      errorproperty="test.failed"
3108      failureproperty="test.failed"
3109      fork="${junit.fork}">
3110      <formatter type="plain"/>
3111      <classpath>
3112        <pathelement location="${build.home}/gsdl3test.jar"/>
3113        <path refid="compile.classpath"/>
3114      </classpath>
3115      <test name="${testcase}" if="testcase"/>
3116      <batchtest todir="${basedir}/test" unless="testcase">
3117        <fileset dir="${build.home}" includes="**/*Test.class" />
3118      </batchtest>
3119    </junit>
3120    <echo>
3121      *********************************************
3122      Test output can be found in directory 'test'
3123      *********************************************
3124    </echo>
3125  </target>
3126
3127  <!-- ======================== FLAX Targets ========================= -->
3128  <target name="prepare-flax" description="check out flax source code from another repository" if="install.flax">
3129    <echo>checking out flax ...</echo>
3130    <mkdir dir="${basedir}/src/java/org/flax"/>
3131    <mkdir dir="${basedir}/src/java/org/greenstone/gsdl3/flax"/>
3132    <mkdir dir="${basedir}/src/java/org/greenstone/gsdl3/action/flax"/>
3133    <mkdir dir="${web.home}/WEB-INF/classes/flax"/>
3134    <mkdir dir="${web.home}/interfaces/flax"/>
3135    <mkdir dir="${web.home}/sites/flax"/>
3136    <mkdir dir="${basedir}/flax-resources"/>
3137    <mkdir dir="${basedir}/flax-lib"/>
3138    <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/src/java/org/flax"/>
3139      <arg value="src/java/org/flax"/></exec>
3140    <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/src/java/org/greenstone/gsdl3/flax"/>
3141      <arg value="src/java/org/greenstone/gsdl3/flax"/></exec>
3142    <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/src/java/org/greenstone/gsdl3/action/flax"/>
3143      <arg value="src/java/org/greenstone/gsdl3/action/flax"/></exec>
3144     <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/web/WEB-INF/classes/flax"/>
3145      <arg value="${web.home}/WEB-INF/classes/flax"/></exec>
3146    <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/web/interfaces/flax"/>
3147      <arg value="${web.home}/interfaces/flax"/></exec>
3148    <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/web/sites/flax"/>
3149      <arg value="${web.home}/sites/flax"/></exec>
3150    <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/flax-resources"/>
3151      <arg value="flax-resources"/></exec>
3152    <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/lib"/>
3153      <arg value="flax-lib"/></exec>
3154    <antcall target="flax-copy-del-files" />
3155  </target>
3156 
3157  <target name="flax-copy-del-files" description="copy some flax files into the appropriate greenstone3 directories and delete some unwanted greenstone stuff">
3158    <copy file="${web.home}/WEB-INF/classes/flax/web.xml" todir="${web.home}/WEB-INF" overwrite="true" />
3159    <copy todir="${web.home}/WEB-INF/lib">
3160            <fileset dir="${basedir}/flax-lib">
3161               <include name="*.jar"/>
3162            </fileset> 
3163    </copy>
3164    <!--<delete dir="${web.home}/sites/gateway"/>
3165    <delete dir="${web.home}/sites/localsite"/>-->
3166  </target>
3167
3168  <target name="update-flax" description="update flax from repository">
3169    <echo>updating flax ...</echo>
3170    <exec executable="svn"><arg value="update"/>
3171      <arg value="src/java/org/flax"/></exec>
3172    <exec executable="svn"><arg value="update"/>
3173      <arg value="src/java/org/greenstone/gsdl3/action/flax"/></exec>
3174    <exec executable="svn"><arg value="update"/>
3175      <arg value="src/java/org/greenstone/gsdl3/flax"/></exec>
3176    <exec executable="svn"><arg value="update"/>
3177      <arg value="${web.home}/WEB-INF/classes/flax"/></exec>
3178    <exec executable="svn"><arg value="update"/>
3179      <arg value="${web.home}/interfaces/flax"/></exec>
3180    <exec executable="svn"><arg value="update"/>
3181      <arg value="${web.home}/web/sites/flax"/></exec>
3182    <exec executable="svn"><arg value="update"/>
3183      <arg value="flax-resources"/></exec>
3184    <exec executable="svn"><arg value="update"/>
3185      <arg value="flax-lib"/></exec>
3186    <antcall target="compile-core" />
3187  </target>
3188
3189  <!-- ========================End of FLAX Targets ========================= -->
3190
3191  <target name="compile-javadocs">
3192    <javadoc packagenames="org.greenstone.*"
3193           sourcepath="src/java"
3194           defaultexcludes="yes"
3195           destdir="docs/javadoc"
3196           author="true"
3197           version="true"
3198           use="true"
3199           windowtitle="Greenstone3 API">
3200    <doctitle><![CDATA[<h1>Greenstone3 API</h1>]]></doctitle>
3201    </javadoc>
3202  </target>
3203
3204<!-- ========== Some distribution targets ======================== -->
3205  <target name="remove-source">
3206    <if><bool><isset property="with.gli.and.gems"/></bool>
3207    <delete includeEmptyDirs="true">
3208      <fileset dir="." defaultexcludes="false">
3209        <patternset refid="greenstone3.source.component"/>
3210     </fileset>
3211    </delete>
3212   
3213    <else>
3214    <delete includeEmptyDirs="true">
3215      <fileset dir="." defaultexcludes="false">
3216        <patternset refid="greenstone3.source.no.gli.component"/>
3217     </fileset>
3218    </delete>
3219    </else>
3220    </if>
3221  </target>
3222
3223  <target name="dist-tidy"
3224    description="'tidies-up' a greenstone3 installation for distribution."
3225    unless="${properties.keep.src}">
3226
3227    <!-- delete unneeded things -->
3228    <delete dir="${packages.home}/axis"/>
3229    <delete><fileset dir="${packages.home}" includes="*.zip"/></delete>
3230    <delete file="README-SVN.txt"/>
3231    <delete file="build.properties.in"/>
3232
3233    <!-- delete source files -->
3234    <antcall target="remove-source"/>
3235
3236    <!-- create empty directories -->
3237    <mkdir dir="${web.writablehome}/applet"/>
3238    <mkdir dir="${web.writablehome}/logs"/>
3239    <mkdir dir="${web.writablehome}/logs/tmp"/>
3240
3241    <!-- Lines with ***** are commented out because these files are useful if we want hybrid installations -->
3242   
3243    <!-- os specific tidy-ups -->
3244    <!-- linux, mac -->
3245    <if><bool><istrue value="${current.os.isunix}"/></bool>
3246      <!--*****<delete><fileset dir="." includes="*.bat"/></delete>-->
3247      <if><bool><isset property="with.gli.and.gems"/></bool>
3248        <!--*****<delete><fileset dir="gli" includes="*.bat"/></delete>-->
3249      </if>
3250      <!--*****<delete><fileset dir="gs2build" includes="*.bat"/></delete>-->
3251      <!--*****<delete><fileset dir="bin/script" includes="*.bat"/></delete>-->
3252      <delete file="${basedir}/gs2build/win32cfg.h"/>
3253      <delete file="${basedir}/gs2build/win32.mak"/>
3254      <delete dir="${basedir}/winutil"/>
3255      <delete failonerror="false"><fileset dir="${lib.jni}" includes="*.dll"/></delete>
3256
3257    <!-- windows -->
3258    <else><if><bool><istrue value="${current.os.iswindows}"/></bool>
3259      <!--*****<delete><fileset dir="." includes="*.sh,*.bash,*.csh"/></delete>-->
3260      <if><bool><isset property="with.gli.and.gems"/></bool>
3261    <!--*****<delete><fileset dir="gli" includes="*.sh,*.bash,*.csh"/></delete>-->
3262      </if>
3263      <!--*****<delete><fileset dir="gs2build" includes="*.sh,*.bash,*.csh"/></delete>-->
3264      <!--*****<delete><fileset dir="bin/script" includes="*.sh,*.bash,*.csh"/></delete>-->
3265    </if></else></if>
3266
3267  </target>
3268
3269  <!-- fix up executable permissions for binary release -->
3270  <target name="fix-execute-permissions">
3271    <echo>Setting binaries to executable</echo>
3272    <chmod perm="775">
3273      <fileset dir="."><patternset refid="greenstone3.executables"/></fileset>
3274    </chmod>
3275  </target>
3276 
3277  <!-- fix up executable permissions for source code release -->
3278  <target name="fix-execute-permissions-source">
3279    <chmod perm="775">
3280      <fileset dir="."><patternset refid="greenstone3.source.executables"/></fileset>
3281    </chmod>
3282  </target>
3283
3284  <!-- for macs, set up the .app shortcuts to gsi, gli, client-gli and gems -->
3285  <target name="gen-mac-shortcuts">   
3286    <if><bool><istrue value="${current.os.ismac}"/></bool>
3287      <filter token="gsdl3srchome" value="${basedir}"/>
3288      <copy file="${basedir}/gs3-server.app/Contents/document.wflow.in" tofile="${basedir}/gs3-server.app/Contents/document.wflow" filtering="true" overwrite="true"/>
3289      <copy file="${basedir}/gli.app/Contents/document.wflow.in" tofile="${basedir}/gli.app/Contents/document.wflow" filtering="true" overwrite="true"/>
3290      <copy file="${basedir}/client-gli.app/Contents/document.wflow.in" tofile="${basedir}/client-gli.app/Contents/document.wflow" filtering="true" overwrite="true"/>
3291      <copy file="${basedir}/gems.app/Contents/document.wflow.in" tofile="${basedir}/gems.app/Contents/document.wflow" filtering="true" overwrite="true"/>
3292    </if>
3293  </target>
3294
3295  <!-- ============= tweaks for making compilation static ========== --> 
3296  <target name="tweak-makefiles" depends="init" if="compile.static">
3297    <antcall target="rtftohtml-add-static" />
3298  </target>
3299   
3300  <target name="rtftohtml-add-static" depends="init" if="collection.building.enabled">
3301    <rsr verbosity="1" file="${gs2build.home}/build-src/packages/rtftohtml/rtftohtml_src/Makefile" pattern="-o rtftohtml(.{2})EXEEXT(.{1})" replacement="-o rtftohtml$1EXEEXT$2 -static" />
3302  </target>
3303   
3304    <target name="run-collection-tests">
3305        <if><bool><not><available file="${basedir}/ext/testing" type="dir"/></not></bool>
3306            <fail>The testing extension is not available. This is required to perform the tests. It can be acquired from SVN by running the command "svn co http://svn.greenstone.org/gs3-extensions/testing/trunk/src testing" in the ext directory of your Greenstone 3 installation. </fail>
3307        </if>
3308        <for param="testjar">
3309            <path>
3310                <fileset dir="${basedir}" includes="web/sites/*/collect/*/tests/tests.jar"/>
3311            </path>
3312            <sequential>
3313                <echo>Testing @{testjar}</echo>
3314                <java classname="org.junit.runner.JUnitCore" fork="true">
3315                    <arg value="gstests.TestClass"/>
3316                    <jvmarg value="-DSERVERURL=http://${tomcat.server}:${tomcat.port}${app.path}${server.default.servlet} "/>
3317                    <classpath>
3318                        <fileset dir="${basedir}/ext/testing/lib/java">
3319                            <include name="*.jar"/>
3320                        </fileset>
3321                        <files includes="@{testjar}"/>
3322                    </classpath>
3323                </java>
3324            </sequential>
3325        </for>
3326    </target>
3327   
3328    <target name="build-collection-tests">
3329        <if><bool><not><available file="${basedir}/ext/testing" type="dir"/></not></bool>
3330            <fail>The testing extension is not available. This is required to perform the tests. It can be acquired from SVN by running the command "svn co http://svn.greenstone.org/gs3-extensions/testing/trunk/src testing" in the ext directory of your Greenstone 3 installation. </fail>
3331        </if>
3332        <for param="compiledir">
3333            <path>
3334                <dirset dir="${basedir}" includes="web/sites/*/collect/*/tests/src"/>
3335            </path>
3336            <sequential>
3337                <echo>Compiling @{compiledir}</echo>
3338                <if><bool><not><available file="@{compiledir}/../build" type="dir"/></not></bool>
3339                    <mkdir dir="@{compiledir}/../build"/>
3340                </if>
3341                <javac
3342                    srcdir="@{compiledir}"
3343                    destdir="@{compiledir}/../build"
3344                        includeantruntime="${compile.includeantruntime}"
3345                    debug="${compile.debug}"
3346                    deprecation="${compile.deprecation}"
3347                    optimize="${compile.optimize}"
3348                    encoding="${compile.encoding}">
3349                    <classpath>
3350                        <fileset dir="${basedir}/ext/testing/lib/java">
3351                            <include name="*.jar"/>
3352                        </fileset>
3353                    </classpath>
3354                    <include name="gstests/*.java"/>
3355                </javac>
3356                <jar destfile="@{compiledir}/../tests.jar">
3357                    <fileset dir="@{compiledir}/../build">
3358                        <include name="gstests/**"/>
3359                    </fileset>
3360                    <manifest>
3361                        <attribute name="Built-By" value="${user.name}" />
3362                    </manifest>
3363                </jar>
3364            </sequential>
3365        </for>
3366    </target>
3367</project>
Note: See TracBrowser for help on using the browser.