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

Revision 32477, 178.4 KB (checked in by ak19, 11 months ago)

HTTPS certification on windows: Using openSSL for generating the account and domain keys, rather than letting zeroSSL do this for us.

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