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

Revision 32422, 174.5 KB (checked in by ak19, 13 months ago)

1. Adding in the command to revoke an https certificate (real or testing) on Windows too. 2. Some bug fixes

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