source: main/trunk/greenstone3/build.xml@ 32792

Last change on this file since 32792 was 32792, checked in by ak19, 5 years ago

Undoing recent commit of forcing the ant force-start-derby target of using the bundled JRE's java. This would only have been correct during the installer. During the installer, launching java directly fails on systems that don't have java installed.
File size: 188.6 KB
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 <property name="sudo.or.not" value="/bin/bash"/><!-- by default, we don't run even special commands with sudo -->
71
72 <property name="os.linux" value="Linux"/>
73 <property name="os.mac" value="Mac OS X"/>
74 <property name="os.solaris" value="SunOS"/>
75 <property name="os.unix" value="${os.linux},${os.mac},${os.solaris}"/>
76 <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!!!-->
77
78 <!-- this is true for linux and macs -->
79 <condition property="current.os.isunix">
80 <os family="unix"/>
81 </condition>
82
83 <condition property="current.os.isunixnotmac">
84 <and>
85 <os family="unix"/>
86 <not>
87 <os family="mac"/>
88 </not>
89 </and>
90 </condition>
91
92 <condition property="current.os.ismac">
93 <os family="mac"/>
94 </condition>
95
96 <condition property="current.os.iswindows">
97 <os family="windows"/>
98 </condition>
99
100 <!-- create build.properties if it has not been created yet -->
101 <if>
102 <bool><not><available file="build.properties"/></not></bool>
103 <copy file="build.properties.svn" tofile="build.properties"/>
104 <property name="first.run" value="true"/>
105 </if>
106
107 <!-- create the packages dir if it has not been created yet -->
108 <mkdir dir="packages"/>
109
110 <!--the first three properties have to be put on the top to be used by build.properties-->
111 <property name="gs2build.home" value="${basedir}${file.separator}gs2build"/>
112 <property name="src.packages.home" value="${basedir}/src/packages"/>
113 <property name="flax.svn.root" value="http://svn.greenstone.org/flax"/>
114
115 <property name="solr-ext.home" value="${basedir}/ext/solr"/>
116
117 <property file="build.properties"/>
118 <if><bool><available file="${user.home}/build.properties"/></bool>
119 <property file="${user.home}/build.properties"/>
120 </if>
121
122 <if>
123 <bool><not><matches string="${server.protocols}" pattern="^\s*(https?|http\s*,\s*https|https\s*,\s*http)\s*$"/></not></bool>
124 <fail>@@@@
125 In file build.properties: invalid value for server.protocols.
126 It must contain http or https, or both (in order of preference) separated by commas.
127 </fail>
128 </if>
129
130 <!--
131 * "valid ports range from 1024–49151" is probably about user assignable ports.
132 But 80 is a valid port for running web servers including GS
133 and in future the range may become greater, so don't restrict the port range to 1024-49151.
134 https://stackoverflow.com/questions/113224/what-is-the-largest-tcp-ip-network-port-number-allowable-for-ipv4
135 -->
136 <if>
137 <bool>
138 <not><matches string="${localhost.port.http}" pattern="^\d{2,}\s*$"/></not>
139 </bool>
140 <fail>...
141 ********* ERROR: localhost.port.http in file build.properties is set to an invalid port number.
142 If port 80 is not possible, user assignable ports range from 1024–49151.
143 But don't choose any port already in use by another application.
144 Try setting to localhost.port.http=8383
145 </fail>
146 </if>
147
148 <!-- if server.protocols contains https, ensure its port number is valid -->
149 <if>
150 <bool>
151 <and>
152 <matches string="${server.protocols}" pattern="https"/>
153 <not><matches string="${tomcat.port.https}" pattern="^\d{2,}\s*$"/></not>
154 </and>
155 </bool>
156 <fail>...
157 ********* ERROR: in file build.properties, server.protocols includes https but
158 tomcat.port.https is set to an invalid port number.
159 If port 443 is not possible, user assignable ports range from 1024–49151.
160 But don't choose any port already in use by another application.
161 Try setting tomcat.port.https=8443
162 </fail>
163 </if>
164
165 <!--
166 Bail if https is enabled but the keystore password (keystore.pass property) is not set.
167 However, keystore.pass has no default value and is therefore not set as a rule.
168 So don't bail when 'ant' is run for the first time to create build.props from build.props.svn.
169 But do bail if running ant.prepare and https enabled and password not set.
170 (Maybe put this entire section before the first target: so we only bail after all non-targets
171 are executed so that any other first ever initialisation is completed?)
172 -->
173 <if>
174 <bool>
175 <and>
176 <matches string="${server.protocols}" pattern="https"/>
177 <or>
178 <not><isset property="keystore.pass"/></not>
179 <matches string="${keystore.pass}" pattern="^\s*$"/>
180 </or>
181 </and>
182 </bool>
183 <if>
184 <bool><isset property="first.run"/></bool>
185 <echo>IMPORTANT: In file build.properties, when property server.protocols includes https,
186 as now, the keystore.pass property must be set to a non-empty value.
187 Either set server.protocols to http by itself, if you don't want support for https,
188 or set keystore.pass if you do want https support.</echo>
189 <else>
190 <fail>...
191 ********* ERROR: server.protocols contains https in file build.properties, but the keystore.pass
192 property required for obtaining/renewing the https certificate is not set or is set to the empty
193 string. Choose a password for keystore.pass and set it in build.properties before proceeding.
194 </fail>
195 </else>
196 </if>
197 </if>
198
199 <!-- Set the keystore file name for linux versus windows. Ultimately unused/inactive if HTTPS
200 isn't enabled and no certificate obtained. We don't yet have https certification on mac -->
201 <condition property="keystore.file" value="fullchain_and_prvtkey.pfx" else="fullchain_and_prvtkey.p12">
202 <istrue value="${current.os.iswindows}"/>
203 </condition>
204
205 <!-- Originally, https redirectPort when using regular http port 8383
206 was always fixed at 8443. Now we use redirectPort=tomcat.port.https.
207 -->
208 <property name="https.redirect.port" value="${tomcat.port.https}"/>
209
210 <!-- The default protocol to be used is the FIRST in the comma separated list for server.protocols
211 The default public tomcat port depends on the default server protocol
212 -->
213 <if>
214 <bool><matches string="${server.protocols}" pattern="^https"/></bool>
215 <property name="default.server.protocol" value="https"/>
216 <property name="default.tomcat.port" value="${tomcat.port.https}"/>
217 <else>
218 <property name="default.server.protocol" value="http"/>
219 <property name="default.tomcat.port" value="${localhost.port.http}"/>
220 </else>
221 </if>
222
223
224 <!-- For setting filter tokens.
225 Used to set up server.xml when configuring tomcat -->
226 <property name="comment.start" value="&lt;!--" />
227 <property name="comment.end" value="--&gt;" />
228
229 <!--
230 If https is enabled, regardless of whether it is the default protocol,
231 there's some more work to do:
232 -
233 - if https is not enabled, comment out its Connecter element in server.xml
234 -->
235 <if>
236 <bool><matches string="${server.protocols}" pattern="https"/></bool>
237 <property name="https.comment.out.start" value=""/>
238 <property name="https.comment.out.end" value=""/>
239
240 <else>
241 <property name="https.comment.out.start" value="${comment.start}"/>
242 <property name="https.comment.out.end" value="${comment.end}"/>
243 </else>
244 </if>
245
246 <!-- if server.protocols doesn't contain http, then http is only to be locally available,
247 e.g. for solr servlet on 127.0.0.1
248 In that case, see https://serverfault.com/questions/218666/how-to-configure-tomcat-to-only-listen-to-127-0-0-1
249 -->
250 <condition property="restrict.http.to.local" value="false" else="true">
251 <matches string="${server.protocols}" pattern="http($|\s+|,)"/>
252 </condition>
253
254 <condition property="http.address.restriction" value="address=&quot;127.0.0.1&quot;" else="">
255 <istrue value="${restrict.http.to.local}"/>
256 </condition>
257
258 <!-- No certificates for localhost: https://letsencrypt.org/docs/certificates-for-localhost/
259 But 'localhost' (or actually, 127.0.0.1) needed for solr: solr servlet not accessible to outside world
260 -->
261 <condition property="local.http.url" value="http://${localhost.server.http}" else="http://${localhost.server.http}:${localhost.port.http}">
262 <equals arg1="${localhost.port.http}" arg2="80" trim="true"/>
263 </condition>
264
265 <!-- On linux, if testing https certification, pass in minus-minus-staging. If not testing on linux, nothing extra to pass in.
266 On windows or mac, if testing https certification, nothing extra to pass in. If not testing on windows or mac, pass in minus-minus-live.
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><or><istrue value="${current.os.iswindows}"/><istrue value="${current.os.ismac}"/></or></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 8.x-->
298 <condition property="tomcat.version" value="apache-tomcat-5.5.25" else="apache-tomcat-8.5.35">
299 <equals arg1="1.4" arg2="${ant.java.version}"/>
300 </condition>
301 <condition property="tomcat.version.major" value="5" else="8">
302 <equals arg1="1.4" arg2="${ant.java.version}"/>
303 </condition>
304 <condition property="privileged.attribute" value="privileged='true'" else="">
305 <equals arg1="8" 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="tomcat8">
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 <!-- During the installer, launching java directly fails on systems that don't have java installed.
1109 Forcing force-start-derby to always use packages/jre/bin/java is wrong too: as gs3-setup does
1110 a lot of work of determining the correct JRE_HOME/JAVA_HOME (not necessarily the GS3 bundled JRE)
1111 and we want to be consistent in using the same java throughout. Solution:
1112 Refer to the JRE used in executing this ant file, which for installers will always be the bundled one.
1113 https://stackoverflow.com/questions/17571595/env-java-home-not-found-ant -->
1114 <exec executable="${java.home}/bin/java" spawn="true"><!-- failonerror="true"-->
1115 <env key="CLASSPATH" path="${derby.server.classpath.prop}"/>
1116 <arg value="org.apache.derby.drda.NetworkServerControl"/>
1117 <arg value="start"/>
1118 <arg value="-p"/>
1119 <arg value="${derby.server.port}"/>
1120 </exec>
1121
1122 </target>
1123
1124 <target name="force-stop-derby">
1125 <java classname="org.apache.derby.drda.NetworkServerControl">
1126 <arg value="shutdown"/>
1127 <arg value="-p"/>
1128 <arg value="${derby.server.port}"/>
1129 <classpath refid="derby.server.classpath"/>
1130 </java>
1131 </target>
1132
1133 <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 -->
1134 <if><bool><istrue value="${derby.isrunning}"/></bool>
1135 <!--<echo>Derby is |${derby.isrunning}| running</echo>-->
1136 <antcall target="force-stop-derby"/>
1137 <else>
1138 <echo>Derby is not running</echo>
1139 </else>
1140 </if>
1141 </target>
1142
1143 <target name="start" depends="needs-gs3-setup,init,configure-tomcat,configure-web,configure-solr-ext,start-derby,start-tomcat"
1144 description="Startup the Tomcat server." >
1145 <echo>${app.name} (${app.version}) server running using Apache Tomcat and Java</echo>
1146 <echo>Tomcat: ${catalina.home}</echo>
1147 <echo>Java : ${java.home}</echo>
1148 <if><bool><available file="${build.src.home}"/></bool>
1149 <echo>Perl : ${full.perl.path}</echo>
1150 </if>
1151 <if><bool><isset property="install.flax"/></bool>
1152 <property name="url" value="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}/flax"/>
1153 <else>
1154 <property name="url" value="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}/"/>
1155 </else>
1156 </if>
1157 <echo>URL : ${url}</echo>
1158 <!-- assuming that index.html is not needed here -->
1159
1160 <!--Now write out the url with oaiserver suffix as the baseURL property in OAIConfig.xml-->
1161 <available file="${basedir}/resources/oai/OAIConfig.xml.in" property="oaiconfig.present"/>
1162 <antcall target="init-oaiconfig">
1163 <param name="url" value="${url}"/>
1164 </antcall>
1165 </target>
1166
1167 <target name="init-oaiconfig" if="oaiconfig.present">
1168 <echo>Writing out baseURL ${url}oaiserver to ${web.writableclasses}/OAIConfig.xml</echo>
1169 <copy file="${basedir}/resources/oai/OAIConfig.xml.in" tofile="${web.writableclasses}/OAIConfig.xml"/>
1170 <rsr verbosity="1" file="${web.writableclasses}/OAIConfig.xml" pattern="&lt;baseURL&gt;.*&lt;/baseURL&gt;" replacement="&lt;baseURL&gt;${url}oaiserver&lt;/baseURL&gt;" />
1171 </target>
1172
1173 <target name="stop" depends="init,stop-tomcat,stop-derby"
1174 description="Shutdown the Tomcat server."/>
1175
1176 <target name="restart" description="Shutdown and restart Tomcat" depends="init,stop,start"/>
1177
1178 <!-- =========== Help targets =================================== -->
1179
1180 <property name="install-command" value="ant [options] prepare install"/>
1181
1182 <target name="usage" description="Print a help message">
1183 <echo message=" Execute 'ant -projecthelp' for a list of targets."/>
1184 <echo message=" Execute 'ant -help' for Ant help."/>
1185 <echo>
1186 To install Greenstone3, run '${install-command}'.
1187 There are properties defined in build.properties. The install
1188 process will ask you if these properties are set correctly.
1189 To avoid this prompt, use the '-Dproperties.accepted=yes'
1190 option.
1191 To log the output, use the '-logfile build.log' option.
1192 The README.txt file has more information about the ant targets
1193 and install process.
1194 </echo>
1195 </target>
1196
1197 <target name="help" depends="usage" description="Print a help message"/>
1198
1199 <target name="debug" depends="init" description="Display all the currently used properties">
1200 <echoproperties/>
1201 </target>
1202
1203 <!-- ====== initialization and setup targets ================== -->
1204
1205 <target name="accept-properties" unless="properties.accepted">
1206 <input addproperty="properties.ok" validargs="y,n">The following properties (among others) are being used from a build.properties file found in this directory:
1207 server.protocols=${server.protocols}
1208 tomcat.server=${tomcat.server}
1209 tomcat.port.https=${tomcat.port.https}
1210 localhost.port.http=${localhost.port.http}
1211
1212 default.server.protocol=${default.server.protocol}
1213 default.tomcat.port=${default.tomcat.port}
1214 Local base HTTP URL used by Greenstone: ${local.http.url}
1215
1216 tomcat.installed.path=${tomcat.installed.path} (this is the location of Tomcat's base dir if it is already installed)
1217 proxy.host=${proxy.host}
1218 proxy.port=${proxy.port}
1219 disable.collection.building=${disable.collection.building}
1220 If these are not acceptable, please change them and rerun this target. Continue [y/n]?
1221 </input>
1222 <condition property="do.abort">
1223 <equals arg1="n" arg2="${properties.ok}"/>
1224 </condition>
1225 <fail if="do.abort">Build aborted by user. Please change your properties settings and re-run the target</fail>
1226 </target>
1227
1228 <!-- this sets up some initial properties -->
1229 <target name="init">
1230
1231 <condition property="java.too.old">
1232 <or>
1233 <equals arg1="1.1" arg2="${ant.java.version}"/>
1234 <equals arg1="1.2" arg2="${ant.java.version}"/>
1235 <equals arg1="1.3" arg2="${ant.java.version}"/>
1236 </or>
1237 </condition>
1238 <fail if="java.too.old" message="You need Java 1.4 or greater to run Greenstone 3"/>
1239
1240 <available file="${basedir}/gli" property="gli.present"/>
1241 <available file="${basedir}/common-src" property="common.src.present"/>
1242 <available file="${basedir}/gs2build" property="gs2build.present"/>
1243 <available file="${gnome-lib-dir}" property="gnome-lib.present"/>
1244
1245 <condition property="tomcat.islocal">
1246 <or>
1247 <not><isset property="tomcat.installed.path"/></not>
1248 <equals arg1="" arg2="${tomcat.installed.path}"/>
1249 </or>
1250 </condition>
1251
1252 <condition property="proxy.present">
1253 <and>
1254 <isset property="proxy.host"/>
1255 <not><equals arg1="" arg2="${proxy.host}"/></not>
1256 </and>
1257 </condition>
1258
1259 <!--
1260 the next block checks if the bundled tomcat is present in the 'packages' directory,
1261 and checks for the lethal combination of tomcat 8 and java 1.4. Test for
1262 tomcat6 is based on the presence of a file inserted by greenstone into the tomcat6
1263 download, as there is no other surefire way to check tomcat version under java 1.4
1264 -->
1265 <condition property="packages.tomcat.ispresent" value="true" else="false">
1266 <available file="packages/tomcat"/>
1267 </condition>
1268 <condition property="packages.tomcat.istomcat8" value="true" else="false">
1269 <available file="packages/tomcat/tomcat8.txt"/>
1270 </condition>
1271 <if>
1272 <bool>
1273 <and>
1274 <istrue value="${packages.tomcat.ispresent}"/>
1275 <istrue value="${packages.tomcat.istomcat8}"/>
1276 <equals arg1="1.4" arg2="${ant.java.version}"/>
1277 </and>
1278 </bool>
1279 <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>
1280 </if>
1281
1282 </target>
1283
1284 <target name="setup-proxy" depends="init" if="proxy.present">
1285 <condition property="ask.user">
1286 <or>
1287 <equals arg1="" arg2="${proxy.user}"/>
1288 <equals arg1="" arg2="${proxy.password}"/>
1289 </or>
1290 </condition>
1291
1292 <getuserandpassword message="Using proxy: ${proxy.host}:${proxy.port}" if="ask.user" username="${proxy.user}" userproperty="proxy.username" pwordproperty="proxy.password"/>
1293 <mysetproxy proxyhost="${proxy.host}" proxyport="${proxy.port}" proxyuser="${proxy.username}" proxypassword="${proxy.password}"/>
1294 </target>
1295
1296 <target name="copy-dot-svn-files" depends="init"
1297 description="Copies all resources .svn files to .in versions - which are used during configure to generate the runtime versions." >
1298 <if><bool><available file="${basedir}/resources/tomcat/greenstone3.xml.in"/></bool>
1299 <copy file="${basedir}/resources/tomcat/greenstone3.xml.in" tofile="${basedir}/resources/tomcat/greenstone3.xml.in.backup" overwrite="true"/>
1300 </if>
1301
1302 <copy file="${basedir}/resources/tomcat/greenstone3.xml.svn" tofile="${basedir}/resources/tomcat/greenstone3.xml.in" overwrite="true"/>
1303 <if><bool><available file="${basedir}/resources/tomcat/server_tomcat5.xml.in"/></bool>
1304 <copy file="${basedir}/resources/tomcat/server_tomcat5.xml.in" tofile="${basedir}/resources/tomcat/server_tomcat5.xml.in.backup" overwrite="true"/>
1305 </if>
1306 <copy file="${basedir}/resources/tomcat/server_tomcat5.xml.svn" tofile="${basedir}/resources/tomcat/server_tomcat5.xml.in" overwrite="true"/>
1307 <if><bool><available file="${basedir}/resources/tomcat/server_tomcat7.xml.in"/></bool>
1308 <copy file="${basedir}/resources/tomcat/server_tomcat7.xml.in" tofile="${basedir}/resources/tomcat/server_tomcat7.xml.in.backup" overwrite="true"/>
1309 </if>
1310 <copy file="${basedir}/resources/tomcat/server_tomcat8.xml.svn" tofile="${basedir}/resources/tomcat/server_tomcat8.xml.in" overwrite="true"/>
1311 <if><bool><available file="${basedir}/resources/tomcat/server_tomcat8.xml.in"/></bool>
1312 <copy file="${basedir}/resources/tomcat/server_tomcat8.xml.in" tofile="${basedir}/resources/tomcat/server_tomcat8.xml.in.backup" overwrite="true"/>
1313 </if>
1314 <copy file="${basedir}/resources/tomcat/server_tomcat8.xml.svn" tofile="${basedir}/resources/tomcat/server_tomcat8.xml.in" overwrite="true"/>
1315 <if><bool><available file="${basedir}/resources/tomcat/web8.xml.in"/></bool>
1316 <copy file="${basedir}/resources/tomcat/web8.xml.in" tofile="${basedir}/resources/tomcat/web8.xml.in.backup" overwrite="true"/>
1317 </if>
1318 <copy file="${basedir}/resources/tomcat/web8.xml.svn" tofile="${basedir}/resources/tomcat/web8.xml.in" overwrite="true"/>
1319 <if><bool><available file="${basedir}/resources/oai/OAIConfig.xml.in"/></bool>
1320 <copy file="${basedir}/resources/oai/OAIConfig.xml.in" tofile="${basedir}/resources/oai/OAIConfig.xml.in.backup" overwrite="true"/>
1321 </if>
1322 <copy file="${basedir}/resources/oai/OAIConfig.xml.svn" tofile="${basedir}/resources/oai/OAIConfig.xml.in" overwrite="true"/>
1323 <if><bool><available file="${basedir}/resources/cgi/gsdl3site.cfg.in"/></bool>
1324 <copy file="${basedir}/resources/cgi/gsdl3site.cfg.in" tofile="${basedir}/resources/cgi/gsdl3site.cfg.in.backup" overwrite="true"/>
1325 </if>
1326 <copy file="${basedir}/resources/cgi/gsdl3site.cfg.svn" tofile="${basedir}/resources/cgi/gsdl3site.cfg.in" overwrite="true"/>
1327 <if><bool><available file="${basedir}/resources/web/global.properties.in"/></bool>
1328 <copy file="${basedir}/resources/web/global.properties.in" tofile="${basedir}/resources/web/global.properties.in.backup" overwrite="true"/>
1329 </if>
1330 <copy file="${basedir}/resources/web/global.properties.svn" tofile="${basedir}/resources/web/global.properties.in" overwrite="true"/>
1331 <if><bool><available file="${basedir}/resources/web/log4j.properties.in"/></bool>
1332 <copy file="${basedir}/resources/web/log4j.properties.in" tofile="${basedir}/resources/web/log4j.properties.in.backup" overwrite="true"/>
1333 </if>
1334 <copy file="${basedir}/resources/web/log4j.properties.svn" tofile="${basedir}/resources/web/log4j.properties.in" overwrite="true"/>
1335 </target>
1336
1337 <!-- ========== Web app Targets ================================ -->
1338
1339 <target name="prepare-web" depends="init">
1340 <mkdir dir="${web.writablehome}/applet"/>
1341 <mkdir dir="${web.writablehome}/logs"/>
1342 <mkdir dir="${web.writablehome}/logs/tmp"/>
1343 </target>
1344
1345 <!-- 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.
1346 The test for whether we need it assumes we won't be trying to compile GS3 against Java versions less than 1.4. -->
1347 <target name="configure-java-version" depends="init"
1348 description="Activates or deactivates some jar libraries as needed depending on your java version">
1349
1350 <available property="have.xalan.jar" file="${web.lib}/xalan.jar"/>
1351 <condition property="need.xalan.jar">
1352 <or>
1353 <not><equals arg1="1.4" arg2="${ant.java.version}"/></not>
1354 </or>
1355 </condition>
1356
1357 <!-- if they have xalan.jar but dont need it -->
1358 <if>
1359 <bool>
1360 <and>
1361 <isset property="have.xalan.jar"/>
1362 <not><isset property="need.xalan.jar"/></not>
1363 </and>
1364 </bool>
1365 <antcall target="deactivate-xalan-jar"/>
1366 </if>
1367
1368 <!-- if they need xalan.jar but dont have it -->
1369 <if>
1370 <bool>
1371 <and>
1372 <not><isset property="have.xalan.jar"/></not>
1373 <isset property="need.xalan.jar"/>
1374 </and>
1375 </bool>
1376 <antcall target="activate-xalan-jar"/>
1377 </if>
1378
1379 </target>
1380
1381 <target name="activate-xalan-jar">
1382 <echo>activating xalan.jar</echo>
1383 <copy file="${web.lib}/xalan.jar.tmp" tofile="${web.lib}/xalan.jar"/>
1384 <if>
1385 <bool>
1386 <and>
1387 <isset property="current.os.ismac"/>
1388 <available file="${catalina.home}/common/endorsed" type="dir"/>
1389 </and>
1390 </bool>
1391 <copy file="${web.lib}/xalan.jar.tmp" tofile="${catalina.home}/common/endorsed/xalan.jar"/>
1392 </if>
1393 </target>
1394
1395 <target name="deactivate-xalan-jar">
1396 <echo>deactivating xalan.jar</echo>
1397 <delete file="${web.lib}/xalan.jar"/>
1398 <!-- should we be deleting common/endorsed/xalan.jar on mac?? -->
1399 </target>
1400
1401
1402 <target name="prepare-collections" depends="init"
1403 description="Unpack all the collections from their svn zipped versions">
1404 <property name="collect.dir" value="${web.home}/sites/localsite/collect"/>
1405 <property name="index-and-archives.zip" value="index-and-archives.zip"/>
1406
1407 <echo message="installing collections..."/>
1408 <antcall target="gs2mgdemo-install"/>
1409 <antcall target="gs2mgppdemo-install"/>
1410 <antcall target="gberg-install"/>
1411 <antcall target="lucene-jdbm-demo-install"/>
1412 </target>
1413
1414 <target name="gs2mgdemo-prepare" if="collect.dir">
1415 <property name="gs2mgdemo.dir" value="${collect.dir}/gs2mgdemo"/>
1416
1417 <condition property="gs2mgdemo.present">
1418 <and>
1419 <available file="${gs2mgdemo.dir}/${index-and-archives.zip}"/>
1420 </and>
1421 </condition>
1422 </target>
1423
1424 <target name="gs2mgdemo-install" if="gs2mgdemo.present" depends="gs2mgdemo-prepare">
1425 <unzip dest="${gs2mgdemo.dir}" src="${gs2mgdemo.dir}/${index-and-archives.zip}" />
1426 <echo>collection gs2mgdemo installed</echo>
1427 </target>
1428
1429 <target name="gs2mgppdemo-prepare" if="collect.dir">
1430 <property name="gs2mgppdemo.dir" value="${collect.dir}/gs2mgppdemo"/>
1431
1432 <condition property="gs2mgppdemo.present">
1433 <and>
1434 <available file="${gs2mgppdemo.dir}/${index-and-archives.zip}"/>
1435 </and>
1436 </condition>
1437 </target>
1438
1439 <target name="gs2mgppdemo-install" if="gs2mgppdemo.present" depends="gs2mgppdemo-prepare">
1440 <unzip dest="${gs2mgppdemo.dir}" src="${gs2mgppdemo.dir}/${index-and-archives.zip}" />
1441 <echo>collection gs2mgppdemo installed</echo>
1442 </target>
1443
1444 <target name="gberg-prepare" if="collect.dir">
1445 <property name="gberg.dir" value="${collect.dir}/gberg"/>
1446 <available file="${gberg.dir}/index/index.zip" property="gberg.present"/>
1447 </target>
1448
1449 <target name="gberg-install" if="gberg.present" depends="gberg-prepare">
1450 <unzip dest="${gberg.dir}/index" src="${gberg.dir}/index/index.zip"/>
1451 <echo>collection gberg installed</echo>
1452 </target>
1453
1454 <target name="lucene-jdbm-demo-prepare" if="collect.dir">
1455 <property name="lucene-jdbm-demo.dir" value="${collect.dir}/lucene-jdbm-demo"/>
1456 <available file="${lucene-jdbm-demo.dir}/${index-and-archives.zip}" property="lucene-jdbm-demo.present"/>
1457 </target>
1458
1459 <target name="lucene-jdbm-demo-install" if="lucene-jdbm-demo.present" depends="lucene-jdbm-demo-prepare">
1460 <unzip dest="${lucene-jdbm-demo.dir}" src="${lucene-jdbm-demo.dir}/${index-and-archives.zip}"/>
1461 <echo>collection lucene-jdbm-demo installed</echo>
1462 </target>
1463
1464
1465 <target name="install-solr-ext" depends="init" >
1466 <exec executable="ant.bat" osfamily="windows" dir="${solr-ext.home}" spawn="false">
1467 <arg value="add-service"/>
1468 </exec>
1469 <exec executable="ant" os="${os.unix}" dir="${solr-ext.home}" spawn="false">
1470 <arg value="add-service"/>
1471 </exec>
1472 <antcall target="solr-jdbm-demo-install"/>
1473 </target>
1474
1475 <target name="solr-jdbm-demo-prepare" if="collect.dir">
1476 <property name="solr-jdbm-demo.dir" value="${collect.dir}/solr-jdbm-demo"/>
1477 <available file="${solr-jdbm-demo.dir}/${index.zip}" property="solr-jdbm-demo.present"/>
1478 </target>
1479
1480 <target name="solr-jdbm-demo-install" if="solr-jdbm-demo.present" depends="solr-jdbm-demo-prepare">
1481 <unzip dest="${solr-jdbm-demo.dir}" src="${solr-jdbm-demo.dir}/${index.zip}"/>
1482 <echo>collection solr-jdbm-demo installed</echo>
1483 </target>
1484
1485 <!-- Until 64 bit Linux and Mac (Lion) machines can generate a working IsisGdl,
1486 use the ones generated on a 32 bit Linux and Mac (Leopard), respectively -->
1487 <target name="get-isisgdl" if="${current.os.isunix}">
1488 <exec executable="uname" dir="${basedir}" failonerror="false"
1489 outputproperty="uname.val">
1490 <arg value="-m"/>
1491 </exec>
1492
1493 <if><bool><equals arg1="${uname.val}" arg2="x86_64"/></bool>
1494 <echo>Bitness: ${uname.val}</echo>
1495 <if><bool><contains string="${os.bin.dir}" substring="darwin" casesensitive="false"/></bool>
1496 <get src="http://www.greenstone.org/caveat-emptor/IsisGdl.macleopard"
1497 dest="${basedir}/gs2build/bin/${os.bin.dir}/IsisGdl"/>
1498 </if>
1499 <if><bool><contains string="${os.bin.dir}" substring="linux" casesensitive="false"/></bool>
1500 <get src="http://www.greenstone.org/caveat-emptor/IsisGdl.bin32"
1501 dest="${basedir}/gs2build/bin/${os.bin.dir}/IsisGdl"/>
1502 </if>
1503 <chmod file="${basedir}/gs2build/bin/${os.bin.dir}/IsisGdl" perm="755"/>
1504 </if>
1505 </target>
1506
1507 <target name="set-perl-shebangs" depends="perl-for-building">
1508 <if>
1509 <bool>
1510 <and><isset property="perl.path"/>
1511 <not><equals arg1="${perl.path}" arg2=""/></not>
1512 </and>
1513 </bool>
1514
1515 <if><bool><istrue value="${current.os.iswindows}"/></bool>
1516 <property name="perl.exec" value="${perl.path}perl.exe"/>
1517 <else>
1518 <property name="perl.exec" value="${perl.path}perl"/>
1519 </else>
1520 </if>
1521
1522 <!--<echo>**** PERLPATH: ${perl.path}</echo>-->
1523 <echo>Setting perl shebangs to Perl Exec: ${perl.exec}</echo>
1524
1525 <!-- set the shebangs in the cgi files to point to the correct perlpath -->
1526 <if>
1527 <bool><not><equals arg1="${web.home}" arg2="${web.writablehome}"></equals></not></bool>
1528 <mkdir dir="${web.writablehome}"/>
1529 <copy file="${full.web.dir}/WEB-INF/cgi/gliserver.pl" tofile="${web.writablehome}/WEB-INF/cgi/gliserver.pl" overwrite="true"/>
1530 <copy file="${full.web.dir}/WEB-INF/cgi/metadata-server.pl" tofile="${web.writablehome}/WEB-INF/cgi/metadata-server.pl" overwrite="true"/>
1531 <copy file="${full.web.dir}/WEB-INF/cgi/checksum.pl" tofile="${web.writablehome}/WEB-INF/cgi/checksum.pl" overwrite="true"/>
1532 </if>
1533
1534 <rsr verbosity="1" file="${web.writablehome}/WEB-INF/cgi/gliserver.pl" pattern="^#!.*" replacement="#!${perl.exec} -w" lines="1"/>
1535 <rsr verbosity="1" file="${web.writablehome}/WEB-INF/cgi/metadata-server.pl" pattern="^#!.*" replacement="#!${perl.exec} -w" lines="1"/>
1536 <rsr verbosity="1" file="${web.writablehome}/WEB-INF/cgi/checksum.pl" pattern="^#!.*" replacement="#!${perl.exec} -w" lines="1"/>
1537 <else>
1538 <echo>WARNING: perl.path is empty. Unable to set the shebangs in the perl files in ${web.writablehome}/WEB-INF/cgi</echo>
1539 </else>
1540 </if>
1541 </target>
1542
1543 <target name="configure-web" depends="init,perl-for-building"
1544 description="Configure only the web app config files">
1545 <!-- we want a unix path in the global.properties file -->
1546 <pathconvert targetos="unix" property="src.gsdl3.home.unix">
1547 <path path="${web.home}"/>
1548 </pathconvert>
1549 <pathconvert targetos="unix" property="src.gsdl3.writablehome.unix">
1550 <path path="${web.writablehome}"/>
1551 </pathconvert>
1552
1553 <antcall target="set-perl-shebangs" inheritAll="true" />
1554
1555 <filter token="gsdlhome" value="${gs2build.home}"/>
1556 <filter token="gsdlhomequoted" value="&quot;${gs2build.home}&quot;"/>
1557 <filter token="gsdl3srchome" value="${basedir}"/>
1558 <filter token="gsdl3srchomequoted" value="&quot;${basedir}&quot;"/>
1559 <filter token="gsdl3home" value="${src.gsdl3.home.unix}"/>
1560 <filter token="gsdl3homequoted" value="&quot;${src.gsdl3.home.unix}&quot;"/>
1561 <filter token="gsdl3writablehome" value="${src.gsdl3.writablehome.unix}"/>
1562 <filter token="gsdl3version" value="${app.version}"/>
1563 <filter token="server.protocols" value="${server.protocols}"/>
1564 <filter token="default.server.protocol" value="${default.server.protocol}"/>
1565 <filter token="tomcat.server" value="${tomcat.server}"/>
1566 <filter token="default.tomcat.port" value="${default.tomcat.port}"/>
1567 <filter token="localhost.server.http" value="${localhost.server.http}"/>
1568 <filter token="localhost.port.http" value="${localhost.port.http}"/>
1569 <filter token="tomcat.port.https" value="${tomcat.port.https}"/>
1570 <filter token="restrict.http.to.local" value="${restrict.http.to.local}"/>
1571 <filter token="greenstone.context" value="${greenstone.context}"/>
1572 <filter token="solr.context" value="${solr.context}"/>
1573 <filter token="derbyserver" value="${derby.server}"/>
1574 <filter token="derbyserver.port" value="${derby.server.port}"/>
1575 <filter token="perlpath" value="${escaped.perl.path}"/>
1576 <filter token="disable.collection.building" value="${disable.collection.building}"/>
1577 <copy file="${basedir}/resources/cgi/gsdl3site.cfg.in" tofile="${web.writablehome}/WEB-INF/cgi/gsdl3site.cfg" filtering="true" overwrite="true"/>
1578 <copy file="${basedir}/resources/web/global.properties.in" tofile="${web.writableclasses}/global.properties" filtering="true" overwrite="true"/>
1579 <copy file="${basedir}/resources/web/log4j.properties.in" tofile="${web.writableclasses}/log4j.properties" filtering="true" overwrite="true"/>
1580 <if><bool><istrue value="${gsdl3home.isreadonly}"/></bool>
1581 <!-- uncomment the writablehome properties -->
1582 <rsr verbosity="1" file="${web.writableclasses}/global.properties" pattern="^#gsdl3\.(writable{1})?home" replacement="gsdl3.$1home" />
1583 </if>
1584 <chmod file="${web.writableclasses}/global.properties" perm="644"/>
1585 <chmod file="${web.writableclasses}/log4j.properties" perm="644"/>
1586 </target>
1587
1588 <target name="compile-web" depends="init">
1589 <javac srcdir="${web.classes}"
1590 destdir="${web.classes}"
1591 includeantruntime="${compile.includeantruntime}"
1592 debug="${compile.debug}"
1593 deprecation="${compile.deprecation}"
1594 optimize="${compile.optimize}"
1595 encoding="${compile.encoding}">
1596 <classpath><path refid="compile.classpath"/></classpath>
1597 </javac>
1598 </target>
1599
1600 <target name="compile-classpath-jars" depends="init">
1601 <if><bool><available file="admin/cp.mf"/></bool>
1602 <jar destfile="admin/cp.jar" manifest="admin/cp.mf"/>
1603 </if>
1604 <if><bool><available file="${lib.java}/cp.mf"/></bool>
1605 <jar destfile="${lib.java}/cp.jar" manifest="${lib.java}/cp.mf"/>
1606 </if>
1607 <if><bool><available file="${lib.jni}/cp.mf"/></bool>
1608 <jar destfile="${lib.jni}/cp.jar" manifest="${lib.jni}/cp.mf"/>
1609 </if>
1610 <if><bool><available file="${web.lib}/cp.mf"/></bool>
1611 <jar destfile="${web.lib}/cp.jar" manifest="${web.lib}/cp.mf"/>
1612 </if>
1613 <jar destfile="cp.jar">
1614 <manifest>
1615 <attribute name="Class-Path" value="server.jar admin/cp.jar lib/java/cp.jar lib/jni/cp.jar web/WEB-INF/lib/cp.jar"/>
1616 </manifest>
1617 </jar>
1618 </target>
1619
1620 <target name="clean-classpath-jars" depends="init">
1621 <delete file="admin/cp.jar"/>
1622 <delete file="${lib.java}/cp.jar"/>
1623 <delete file="${lib.jni}/cp.jar"/>
1624 <delete file="${web.lib}/cp.jar"/>
1625 <delete file="cp.jar"/>
1626 </target>
1627
1628
1629 <target name="svnupdate-web" unless="nosvn.mode">
1630 <exec executable="svn">
1631 <arg value="update"/>
1632 <arg value="${web.writablehome}"/>
1633 <arg value="-r"/><arg value="${branch.revision}"/>
1634 </exec>
1635 </target>
1636
1637 <target name="update-web" depends="init,svnupdate-web,configure-web"
1638 description="update only the web stuff (config files)"/>
1639
1640 <!-- ============ Targets concerned with https certification ================ -->
1641
1642 <target name="setup-https-cert-info">
1643 <echo>
1644 *********************************************************************
1645 NOTE TO OBTAINING A TLS (SSL) CERTIFICATE FOR HTTPS
1646 *********************************************************************
1647 A signed certificate is needed for your GS server to serve pages over https.
1648 This target will attempt to obtain a certificate for you from the official and free Certificate Authority Let's Encrypt.
1649 However, a certificate can only be obtained if you have admin/sudo permissions on this machine that you're installing Greenstone on.
1650
1651 Note that:
1652 * 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.
1653 * 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.
1654 </echo>
1655 </target>
1656
1657
1658 <target name="https-conditions-set">
1659 <input addproperty="https.conditions.ok" validargs="y,n">
1660 To run this target, ensure you have:
1661 * (if on unix) sudo permissions. Enter the sudo password if prompted.
1662 * (if on windows) sufficient privileges to run the included tomcat on port 80.
1663 * nothing running on port 80 when you run this target
1664 * edited the build.properties file with
1665 - tomcat.server set to the/a domain name of your server
1666 - server.protocols comma-separated list set to contain at least 'https' if not also http (the first in this list will be the default protocol)
1667 - tomcat.port.https set to a valid port number not yet in use
1668 - keystore.pass set to a password for the certification process
1669 * read the Let's Encrypt Subscriber Agreement at https://letsencrypt.org/repository/
1670 If any of the above is not possible, quit this target. Continue [y/n]?
1671 </input>
1672
1673 <condition property="quit.https.setup">
1674 <equals arg1="n" arg2="${https.conditions.ok}"/>
1675 </condition>
1676
1677 <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>
1678 </target>
1679
1680
1681 <target name="setup-https-cert" depends="setup-https-cert-info,https-conditions-set">
1682 <if><bool><not><matches string="${server.protocols}" pattern="https"/></not></bool>
1683 <fail>To setup https certification, the server.protocols property in file build.properties must contain 'https'</fail>
1684 </if>
1685
1686 <input addproperty="https.cert.email">Enter an email that Let's Encrypt, the certification authority, can send any important notifications to</input>
1687 <input addproperty="https.other.domains">Besides tomcat.server=${tomcat.server}, enter a comma separated list of additional domains to support, if any</input>
1688 <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>
1689 <if>
1690 <bool><equals arg1="y" arg2="${https.cert.agree}"/></bool>
1691
1692 <condition property="https.cert.domains" value="${tomcat.server},${https.other.domains}" else="${tomcat.server}">
1693 <and>
1694 <isset property="https.other.domains" />
1695 <not><matches string="${https.other.domains}" pattern="^\s*$"/></not>
1696 </and>
1697 </condition>
1698
1699 <input addproperty="https.do.cert" validargs="y,n">
1700 You've agreed to the Let's Encrypt TOS with
1701 - email: ${https.cert.email}
1702 - domains: ${https.cert.domains}
1703 Looks okay? [y/n]
1704 </input>
1705 </if>
1706
1707 <if><bool><equals arg1="n" arg2="${https.do.cert}"/></bool>
1708 <echo>Not proceeding with https certification for the Greenstone 3 web server</echo>
1709 <else>
1710 <echo>Proceeding...</echo>
1711 <if><bool><istrue value="${current.os.iswindows}"/></bool>
1712 <antcall target="setup-https-cert-windows">
1713 <param name="https.cert.renewal" value=""/><!-- for cert issuance, there are none of the additional parameters specific to cert renewal -->
1714 </antcall>
1715 </if>
1716 <if><bool><istrue value="${current.os.isunixnotmac}"/></bool>
1717 <antcall target="setup-https-cert-linux"/>
1718 </if>
1719 <if><bool><istrue value="${current.os.ismac}"/></bool>
1720 <antcall target="setup-https-cert-mac"/>
1721 </if>
1722 </else>
1723 </if>
1724
1725 </target>
1726
1727
1728 <target name="setup-https-cert-windows">
1729
1730 <echo>********** The included tomcat will be stopped, then restarted on port 80 and stopped again</echo>
1731
1732 <!-- create folder packages\tomcat\webapps\ROOT\.well-known\acme-challenge -->
1733 <mkdir dir="${packages.home}/tomcat/webapps/ROOT/.well-known/acme-challenge"/>
1734 <mkdir dir="${packages.home}/tomcat/conf/https_cert"/>
1735
1736 <!--
1737 For Windows, Greenstone can generate the account and domain keys with the openSSL we compiled up ourselves
1738 and put on SVN (at GS3/bin/windows/openssl) rather than let ZeroSSL generate these keys for the user.
1739 Letting Greenstone generate the keys may be considered more trustworthy by the user than letting a 3rd
1740 party do so. See https://zerossl.com/usage.html#First_time_run_and_regular_use for OpenSSL commands
1741 If we don't generate the keys ourselves with our OpenSSL, then ZeroSSL will do so automatically in the
1742 call to le64/32.exe further below, as it's passed in the flag generate-missing.
1743 -->
1744 <!-- We generate the account key named "privkey.key" in ${packages.home}\tomcat\conf\https_cert -->
1745 <exec executable="cmd" osfamily="windows" dir="${basedir}/bin/${os.bin.dir}/openssl/bin" spawn="false">
1746 <arg value="/c" />
1747 <arg value="openssl.exe" />
1748 <arg value="genrsa" />
1749 <arg value="-out" /><arg value="${packages.home}\tomcat\conf\https_cert\privkey.key" /><arg value="4096" />
1750 </exec>
1751
1752 <!-- Also generate the domain key (for csr-key parameter to zeroSSL's le.exe)
1753 ${packages.home}\tomcat\conf\https_cert\${tomcat.server}.key
1754 Using 2048 instead of 4096 bits for this. See https://zerossl.com/usage.html#First_time_run_and_regular_use
1755 -->
1756 <exec executable="cmd" osfamily="windows" dir="${basedir}/bin/${os.bin.dir}/openssl/bin" spawn="false">
1757 <arg value="/c" />
1758 <arg value="openssl.exe" />
1759 <arg value="genrsa" />
1760 <arg value="-out" /><arg value="${packages.home}\tomcat\conf\https_cert\${tomcat.server}.key" /><arg value="2048" />
1761 </exec>
1762
1763 <!-- stop the included tomcat (also stopping derby and solr) -->
1764 <antcall target="stop" />
1765
1766 <!-- rerun tomcat on port 80
1767 See https://ant.apache.org/manual/Tasks/antcall.html -->
1768 <antcall target="start">
1769 <param name="localhost.port.http" value="80"/>
1770 <param name="default.tomcat.port" value="80"/>
1771 <param name="local.http.url" value="http://${localhost.server.http}"/><!-- For port 80 over http, leave out port number in URL -->
1772 <param name="http.address.restriction" value=""/><!-- don't prevent public access over http of port 80 -->
1773 <param name="https.comment.out.start" value="${comment.start}"/>
1774 <param name="https.comment.out.end" value="${comment.end}"/>
1775 </antcall>
1776
1777 <!-- get the certificate: use zerossl for windows
1778 Download from https://github.com/do-know/Crypt-LE/releases,
1779 For licence see https://github.com/do-know/Crypt-LE/
1780 Usage instructions at https://zerossl.com/usage.html
1781
1782 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}"
1783
1784 which generates a .pfx file with the same name as the PEM certificate (.crt param below)
1785 .pfx vs .p12: https://stackoverflow.com/questions/6819079/convert-pfx-format-to-p12
1786
1787 In this case "fullchain_and_prvtkey.pfx" is generated, which is the windows value of ${keystore.file} property
1788
1789 Helpful for debugging: https://stackoverflow.com/questions/10302489/ant-script-have-exec-tag-dump-out-entire-command-line
1790 -->
1791 <exec executable="cmd" osfamily="windows" dir="${basedir}/bin/${os.bin.dir}" spawn="false">
1792 <arg value="/c" />
1793 <arg value="le${os.bitness}" />
1794 <arg value="--key" /><arg value="${packages.home}\tomcat\conf\https_cert\privkey.key" />
1795 <arg value="--csr" /><arg value="${packages.home}\tomcat\conf\https_cert\${tomcat.server}.csr" />
1796 <arg value="--csr-key" /><arg value="${packages.home}\tomcat\conf\https_cert\${tomcat.server}.key" />
1797 <!--<arg value="==crt" /><arg value="${packages.home}\tomcat\conf\https_cert\${tomcat.server}.crt" />-->
1798 <arg value="--crt" /><arg value="${packages.home}\tomcat\conf\https_cert\fullchain_and_prvtkey.crt" />
1799 <arg value="--domains" /><arg value="${https.cert.domains}" />
1800 <arg value="--path" /><arg value="${packages.home}\tomcat\webapps\ROOT\.well-known\acme-challenge" />
1801 <arg value="--generate-missing" />
1802 <arg value="--unlink" />
1803 <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 -->
1804 <!--<arg value="==export-pfx" /><arg value="${keystore.pass}" />
1805 <arg value="==tag-pfx" /><arg value="greenstone3-tomcat" />--><!--Convert the certificate (that contains the full chain AND private key) to pfx format hereafter using OpenSSL instead-->
1806 <arg line="${https.cert.renewal}" /><!-- renew command on windows/mac appends min-min-renew XX, where if the day the renewal is run is XX days within expiry, the certificate will get renewed. -->
1807 </exec>
1808
1809 <!-- stop the tomcat running on port 80 -->
1810 <antcall target="stop">
1811 <param name="localhost.port.http" value="80"/>
1812 <param name="default.tomcat.port" value="80"/>
1813 <param name="local.http.url" value="http://${localhost.server.http}"/><!-- For port 80 over http, leave out port number in URL -->
1814 <param name="http.address.restriction" value=""/>
1815 <param name="https.comment.out.start" value="${comment.start}"/>
1816 <param name="https.comment.out.end" value="${comment.end}"/>
1817 </antcall>
1818
1819 <!-- Use OpenSSL instead of ZeroSSL to convert the certificate to the .pfx format that tomcat likes, using this cmd:
1820 GS3/bin/windows/openssl/bin/openssl.exe pkcs12 -inkey domain.key -in domain.crt -passin pass:pwd -passout pass:pwd -export -out ${keystore.file}
1821 GS3/bin/windows/openssl/bin/openssl.exe pkcs12 -inkey domain.key -in domain.crt -password pass:pwd -export -out ${keystore.file}
1822 where on windows, keystore.file = fullchain_and_prvtkey.pfx
1823 -->
1824 <exec executable="cmd" osfamily="windows" dir="${basedir}/bin/${os.bin.dir}/openssl/bin" spawn="false">
1825 <arg value="/c" />
1826 <arg value="openssl.exe" />
1827 <arg value="pkcs12" />
1828 <arg value="-inkey" /><arg value="${packages.home}\tomcat\conf\https_cert\${tomcat.server}.key" />
1829 <arg value="-in" /><arg value="${packages.home}\tomcat\conf\https_cert\fullchain_and_prvtkey.crt" />
1830 <arg value="-export" />
1831 <arg value="-out" /><arg value="${packages.home}\tomcat\conf\https_cert\${keystore.file}" />
1832 <arg value="-name"/><arg value="greenstone3-tomcat"/><!-- See https://stackoverflow.com/questions/808669/convert-a-cert-pem-certificate-to-a-pfx-certificate -->
1833 <arg value="-password"/><arg value="pass:${keystore.pass}"/>
1834 </exec>
1835
1836 </target>
1837
1838
1839 <!-- On Mac as on Linux, we need sudo permissions to setup https certification.
1840 But unlike on Linux, on Mac we only need to sudo when running tomcat on port 80
1841 and when stopping tomcat running on port 80. But we don't need to sudo on a Mac when calling le.pl.
1842 This also means all the files in https_cert have the correct (user, not root) permissions.
1843 -->
1844 <target name="setup-https-cert-mac">
1845
1846 <echo>********** The included tomcat will be stopped, then restarted on port 80 and stopped again</echo>
1847
1848 <!-- create folder packages\tomcat\webapps\ROOT\.well-known\acme-challenge -->
1849 <mkdir dir="${packages.home}/tomcat/webapps/ROOT/.well-known/acme-challenge"/>
1850 <mkdir dir="${packages.home}/tomcat/conf/https_cert"/>
1851
1852 <!--
1853 See comments under setup-https-cert-WINDOWS
1854 -->
1855 <!-- We generate the account key named "privkey.key" in ${packages.home}\tomcat\conf\https_cert -->
1856 <if><bool><not><available file="${packages.home}/tomcat/conf/https_cert/privkey.key"/></not></bool>
1857 <exec executable="openssl" osfamily="mac" dir="${basedir}/bin/${os.bin.dir}/openssl/bin" spawn="false">
1858 <arg value="genrsa" />
1859 <arg value="-out" /><arg value="${packages.home}/tomcat/conf/https_cert/privkey.key" /><arg value="4096" />
1860 </exec>
1861 </if>
1862
1863 <!-- Also generate the domain key (for csr-key parameter to zeroSSL's le.pl)
1864 ${packages.home}\tomcat\conf\https_cert\${tomcat.server}.key
1865 Using 2048 instead of 4096 bits for this. See https://zerossl.com/usage.html#First_time_run_and_regular_use
1866 -->
1867 <if><bool><not><available file="${packages.home}/tomcat/conf/https_cert/${tomcat.server}.key"/></not></bool>
1868 <exec executable="openssl" osfamily="mac" dir="${basedir}/bin/${os.bin.dir}/openssl/bin" spawn="false">
1869 <arg value="genrsa" />
1870 <arg value="-out" /><arg value="${packages.home}/tomcat/conf/https_cert/${tomcat.server}.key" /><arg value="2048" />
1871 </exec>
1872 </if>
1873
1874 <!-- stop the included tomcat (also stopping derby and solr) -->
1875 <antcall target="stop" />
1876
1877 <!-- rerun tomcat on port 80
1878 See https://ant.apache.org/manual/Tasks/antcall.html -->
1879 <antcall target="start">
1880 <param name="sudo.or.not" value="/usr/bin/sudo" />
1881 <param name="localhost.port.http" value="80"/>
1882 <param name="default.tomcat.port" value="80"/>
1883 <param name="local.http.url" value="http://${localhost.server.http}"/><!-- For port 80 over http, leave out port number in URL -->
1884 <param name="http.address.restriction" value=""/><!-- don't prevent public access over http of port 80 -->
1885 <param name="https.comment.out.start" value="${comment.start}"/>
1886 <param name="https.comment.out.end" value="${comment.end}"/>
1887 </antcall>
1888
1889 <!-- get the certificate: use zerossl's le.pl compiled up for Mac.
1890 For further notes, see under setup-https-cert-WINDOWS
1891 -->
1892
1893 <exec executable="perl" osfamily="mac" dir="${gs2build.home}/perllib/cpan/Crypt/LE/bin" spawn="false">
1894 <env key="PERL5LIB" value="${gs2build.home}/perllib/cpan${path.separator}${gs2build.home}/perllib/cpan/perl-5.18"/>
1895 <arg value="-S" />
1896 <arg value="${gs2build.home}/perllib/cpan/Crypt/LE/bin/le.pl" />
1897 <arg value="--key" /><arg value="${packages.home}/tomcat/conf/https_cert/privkey.key" />
1898 <arg value="--csr" /><arg value="${packages.home}/tomcat/conf/https_cert/${tomcat.server}.csr" />
1899 <arg value="--csr-key" /><arg value="${packages.home}/tomcat/conf/https_cert/${tomcat.server}.key" />
1900 <!--<arg value="==crt" /><arg value="${packages.home}/tomcat/conf/https_cert/${tomcat.server}.crt" />-->
1901 <arg value="--crt" /><arg value="${packages.home}/tomcat/conf/https_cert/fullchain_and_prvtkey.crt" />
1902 <arg value="--domains" /><arg value="${https.cert.domains}" />
1903 <arg value="--path" /><arg value="${packages.home}/tomcat/webapps/ROOT/.well-known/acme-challenge" />
1904 <arg value="--generate-missing" />
1905 <arg value="--unlink" />
1906 <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 -->
1907 <!--<arg value="==export-pfx" /><arg value="${keystore.pass}" />
1908 <arg value="==tag-pfx" /><arg value="greenstone3-tomcat" />--><!-- not sure if this generates a keystore filename with ext .p12 or .pfx for Macs -->
1909 <arg line="${https.cert.renewal}" /><!-- renew command on windows/mac appends min-min-renew XX, where if the day the renewal is run is XX days within expiry, the certificate will get renewed. -->
1910 </exec>
1911
1912 <!-- stop the tomcat running on port 80 -->
1913 <antcall target="stop">
1914 <param name="sudo.or.not" value="/usr/bin/sudo" />
1915 <param name="localhost.port.http" value="80"/>
1916 <param name="default.tomcat.port" value="80"/>
1917 <param name="local.http.url" value="http://${localhost.server.http}"/>
1918 <param name="http.address.restriction" value=""/>
1919 <param name="https.comment.out.start" value="${comment.start}"/>
1920 <param name="https.comment.out.end" value="${comment.end}"/>
1921 </antcall>
1922
1923 <!-- Use OpenSSL instead of ZeroSSL to convert the certificate to the .pfx format that tomcat likes, using this cmd:
1924 GS3/bin/windows/openssl/bin/openssl.exe pkcs12 -inkey domain.key -in domain.crt -passin pass:pwd -passout pass:pwd -export -out ${keystore.file}
1925 GS3/bin/windows/openssl/bin/openssl.exe pkcs12 -inkey domain.key -in domain.crt -password pass:pwd -export -out ${keystore.file}
1926 where on windows, keystore.file = fullchain_and_prvtkey.pfx
1927 -->
1928 <exec executable="openssl" osfamily="mac" dir="${basedir}/bin/${os.bin.dir}/openssl/bin" spawn="false">
1929 <arg value="pkcs12" />
1930 <arg value="-inkey" /><arg value="${packages.home}/tomcat/conf/https_cert/${tomcat.server}.key" />
1931 <arg value="-in" /><arg value="${packages.home}/tomcat/conf/https_cert/fullchain_and_prvtkey.crt" />
1932 <arg value="-export" />
1933 <arg value="-out" /><arg value="${packages.home}/tomcat/conf/https_cert/${keystore.file}" />
1934 <arg value="-name"/><arg value="greenstone3-tomcat"/><!-- See https://stackoverflow.com/questions/808669/convert-a-cert-pem-certificate-to-a-pfx-certificate -->
1935 <arg value="-password"/><arg value="pass:${keystore.pass}"/>
1936 </exec>
1937
1938 </target>
1939
1940
1941
1942 <target name="setup-https-cert-linux">
1943 <!-- Running as
1944 ./certbot-auto certonly ==standalone ==preferred-challenges http ==email EMAIL -d DOMAINS
1945 expects input from stdin to accept (A) ToS and say Yes (Y) to sharing email.
1946 We can run in non-interactive mode as the user has at this stage already agreed
1947 to LetsEncrypt's Terms of Service and provided an email address.
1948 -->
1949 <exec executable="/bin/bash" dir="${basedir}/bin/${os.bin.dir}" failonerror="true">
1950 <arg value="./certbot-auto"/>
1951 <arg value="certonly"/>
1952 <arg line="${https.testing}"/><!-- https://stackoverflow.com/questions/11840284/pass-arguments-to-apache-ant-exec-task-based-on-the-variables-value -->
1953 <arg value="--standalone"/>
1954 <arg value="--non-interactive"/>
1955 <arg value="--agree-tos"/>
1956 <arg value="--preferred-challenges"/><arg value="http"/>
1957 <arg value="--email"/><arg value="${https.cert.email}"/>
1958 <arg value="--domains"/><arg value="${https.cert.domains}"/>
1959 </exec>
1960
1961 <!-- sudo openssl pkcs12 -export -out /tmp/DOMAIN_fullchain_and_key.p12 \
1962 -in /etc/letsencrypt/live/DOMAIN/fullchain.pem \
1963 -inkey /etc/letsencrypt/live/DOMAIN/privkey.pem \
1964 -name tomcat
1965 Must run as sudo because only admin has access to the pem files that admin
1966 generated in /etc/letsencrypt
1967 See https://computingforgeeks.com/tomcat-7-with-letsencrypt-ssl-certificate/
1968 but also https://community.letsencrypt.org/t/using-lets-encrypt-with-tomcat/41082
1969 which bypasses the step to generate the java keystore jks file
1970 and uses openssl to generate a pfx file instead of a p12 file
1971 -->
1972
1973 <exec executable="sudo" dir="/tmp" failonerror="true">
1974 <arg value="${basedir}/bin/${os.bin.dir}/openssl/bin/openssl"/>
1975 <arg value="pkcs12"/>
1976 <arg value="-export"/>
1977 <arg value="-out"/><arg value="/tmp/${tomcat.server}_fullchain_and_key.p12"/>
1978 <arg value="-in"/><arg value="/etc/letsencrypt/live/${tomcat.server}/fullchain.pem"/>
1979 <arg value="-inkey"/><arg value="/etc/letsencrypt/live/${tomcat.server}/privkey.pem"/>
1980 <arg value="-name"/><arg value="greenstone3-tomcat"/>
1981 <arg value="-password"/><arg value="pass:${keystore.pass}"/>
1982 </exec>
1983
1984 <!-- Finally, mkdir ${packages.home}/tomcat/conf/https_cert
1985 and copy the file /tmp/${tomcat.server}_fullchain_and_key.p12 into it
1986 and rename to a slightly shorter and simpler name,
1987 see https://stackoverflow.com/questions/8971187/ant-renaming-while-copying-file
1988 The file in tmp has root permissions. But copying it from tmp into
1989 the local account will give the copy local account permissions.
1990 Then sudo to remove the original copy in /tmp
1991 -->
1992 <mkdir dir="${packages.home}/tomcat/conf/https_cert"/>
1993 <!--<copy file="/tmp/${tomcat.server}_fullchain_and_key.p12" todir="${packages.home}/tomcat/conf/https_cert"/>-->
1994 <copy todir="${packages.home}/tomcat/conf/https_cert">
1995 <fileset file="/tmp/${tomcat.server}_fullchain_and_key.p12"/>
1996 <globmapper from="${tomcat.server}_fullchain_and_key.p12" to="${keystore.file}"/>
1997 </copy>
1998
1999 <exec executable="sudo" dir="/tmp" failonerror="true">
2000 <arg line="rm -f /tmp/${tomcat.server}_fullchain_and_key.p12" />
2001 </exec>
2002
2003 </target>
2004
2005
2006 <!-- Revoke the certificate and remove it, including folders.
2007 See https://certbot.eff.org/docs/using.html#revoking-certificates
2008 which also states "if a certificate is a test certificate obtained via the
2009 ==staging or ==test-cert flag, that flag must be passed to the revoke subcommand."
2010 -->
2011 <target name="remove-https-cert">
2012 <echo>
2013 NOTE: If you're on Linux, you need to have sudo permissions to execute this target.
2014 Enter the sudo password if prompted.
2015 </echo>
2016 <!--
2017 On linux, we use certbot-auto.
2018 It says at https://github.com/certbot/certbot/issues/1741
2019 "you shouldn't run letsencrypt-auto [now called certbot-auto] as superuser,
2020 because the program will invoke sudo when it needs to automatically."
2021 We need to send Y(es) as inputstring to confirm that the
2022 /etc/letsencrypt/live/${tomcat.server} folder can be deleted.
2023 Note osfamily="unix" is separate from osfamily="mac", which comes out handy here as we haven't set up certbot-auto for mac (yet).
2024 -->
2025 <exec executable="./certbot-auto" os="${os.linux},${os.solaris}" dir="${basedir}/bin/${os.bin.dir}" failonerror="true" inputstring="Y">
2026 <arg value="revoke"/>
2027 <arg line="${https.testing}"/>
2028 <arg value="--cert-path"/><arg value="/etc/letsencrypt/live/${tomcat.server}/cert.pem"/>
2029 </exec>
2030 <!-- The above command already deletes the folder when Y(es) was passed in. Explicitly deleting:
2031 <exec executable="./certbot-auto" dir="${basedir}/bin/${os.bin.dir}" failonerror="true">
2032 <arg value="delete"/>
2033 <arg value="==cert-name"/><arg value="${tomcat.server}"/>
2034 </exec>
2035 -->
2036
2037 <!-- On Windows and Mac, we use zeroSSl. For the revoke command, see https://zerossl.com/usage.html#Certificate_revocation -->
2038 <exec executable="cmd" osfamily="windows" dir="${basedir}/bin/${os.bin.dir}" spawn="false">
2039 <arg value="/c" />
2040 <arg value="le${os.bitness}" />
2041 <arg value="--key" /><arg value="${packages.home}\tomcat\conf\https_cert\privkey.key" />
2042 <arg value="--crt" /><arg value="${packages.home}\tomcat\conf\https_cert\fullchain_and_prvtkey.crt"/>
2043 <arg value="--revoke"/>
2044 <arg line="${https.testing}"/>
2045 </exec>
2046
2047 <!-- On Mac, we use the le.pl we compiled up (Crypt::LE) and which needs to have PERL5LIB set correctly to run -->
2048 <exec executable="perl" osfamily="mac" dir="${gs2build.home}/perllib/cpan/Crypt/LE/bin" spawn="false">
2049 <env key="PERL5LIB" value="${gs2build.home}/perllib/cpan${path.separator}${gs2build.home}/perllib/cpan/perl-5.18"/>
2050 <arg value="-S" />
2051 <arg value="${gs2build.home}/perllib/cpan/Crypt/LE/bin/le.pl" />
2052 <arg value="--key" /><arg value="${packages.home}/tomcat/conf/https_cert/privkey.key" />
2053 <arg value="--crt" /><arg value="${packages.home}/tomcat/conf/https_cert/fullchain_and_prvtkey.crt"/>
2054 <arg value="--revoke"/>
2055 <arg line="${https.testing}"/>
2056 </exec>
2057
2058 <!-- And remove the https_cert folder -->
2059 <delete dir="${packages.home}/tomcat/conf/https_cert"/>
2060 </target>
2061
2062
2063 <!-- Renewing existing https certificate
2064 Linux:
2065 https://certbot.eff.org/docs/using.html#renewing-certificates
2066 ./path/to/GS3/bin/linux/certbot-auto renew ==quiet ==no-self-upgrade
2067 Windows: reuse Windows issuance target
2068 see https://zerossl.com/usage.html#Certificate_renewal
2069 -->
2070 <target name="renew-existing-https-cert">
2071 <echo>
2072 NOTE: To run this target,
2073 * ensure nothing is running on port 80
2074 * if you're on Linux or Mac, you need to have sudo permissions. Enter the sudo password if prompted.
2075
2076 If you want your cronjob to renew a certificate, you can add pre and post hooks
2077 refer to https://certbot.eff.org/docs/using.html#renewing-certificates
2078 For more information run:
2079 ./path/to/GS3/bin/linux/certbot-auto --help renew
2080 </echo>
2081 <exec executable="./certbot-auto" os="${os.linux},${os.solaris}" dir="${basedir}/bin/${os.bin.dir}" failonerror="true">
2082 <arg value="renew"/>
2083 <arg value="--quiet"/>
2084 <arg value="--no-self-upgrade"/>
2085 </exec>
2086
2087 <!-- For renewal on Windows or Mac, we use ZeroSSL as intermediary between GS3 and Let's Encrypt.
2088 And when using ZeroSSL we need to re-run the original (issuance) command and append "min-min-renew XX" to it,
2089 where if it's within XX days of expiry, the certificate will get renewed.
2090 See https://zerossl.com/usage.html#Certificate_renewal -->
2091 <if><bool><or>
2092 <istrue value="${current.os.iswindows}"/>
2093 <istrue value="${current.os.ismac}"/>
2094 </or></bool>
2095
2096 <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>
2097 <condition property="https.cert.domains" value="${tomcat.server},${https.other.domains}" else="${tomcat.server}">
2098 <and>
2099 <isset property="https.other.domains" />
2100 <not><matches string="${https.other.domains}" pattern="^\s*$"/></not>
2101 </and>
2102 </condition>
2103 <if><bool><istrue value="${current.os.iswindows}"/></bool>
2104 <antcall target="setup-https-cert-windows">
2105 <param name="https.cert.renewal" value="--renew 10"/>
2106 </antcall>
2107 <else>
2108 <antcall target="setup-https-cert-mac">
2109 <param name="https.cert.renewal" value="--renew 10"/>
2110 </antcall>
2111 </else>
2112 </if>
2113 </if>
2114 </target>
2115
2116 <!-- ======================= Tomcat Targets ========================== -->
2117
2118 <!-- this target downloads and installs Tomcat -->
2119 <!-- we download tomcat (version 7 for Java 1.5 and later, version 5 for Java 1.4 plus the 1.4 compatibility package). -->
2120 <target name="prepare-tomcat" depends="init,setup-proxy" if="tomcat.islocal"
2121 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">
2122 <if>
2123 <bool>
2124 <not><available file="${packages.home}/tomcat/.flagfile"/></not>
2125 </bool>
2126
2127 <!-- check that packages dir is there -->
2128 <mkdir dir="${packages.home}"/>
2129 <get src="http://www.greenstone.org/gs3files/${tomcat.version}.zip"
2130 dest="${packages.home}/${tomcat.version}.zip"
2131 usetimestamp="true"/>
2132 <unzip src="${packages.home}/${tomcat.version}.zip"
2133 dest="${packages.home}"/>
2134
2135 <!-- If we are using Java 1.4, we'd be using tomcat 5.5 in which case
2136 we would need to have the tomcat compat package to work with Java 1.4-->
2137 <if>
2138 <bool><equals arg1="1.4" arg2="${ant.java.version}"/></bool>
2139 <get src="http://www.greenstone.org/gs3files/${tomcat.version}-compat.zip"
2140 dest="${packages.home}/${tomcat.version}-compat.zip"
2141 usetimestamp="true"/>
2142 <unzip src="${packages.home}/${tomcat.version}-compat.zip"
2143 dest="${packages.home}"/>
2144 </if>
2145
2146 <!-- delete any existing tomcat -->
2147 <delete dir="${packages.home}/tomcat"/>
2148 <move todir="${packages.home}/tomcat">
2149 <fileset dir="${packages.home}/${tomcat.version}"/>
2150 </move>
2151
2152 <!-- To avoid the CGI permissions error appearing continuously in the (localhost) log,
2153 need privileged=true set in the root context.xml file too, not just greenstone context file.
2154 See http://stackoverflow.com/questions/9845936/tomcat-v7-0-load-exception-marking-servlet-ssi-as-unavailable/10305471#10305471
2155 For usage of IfTask IsLessThan: http://antelope.stage.tigris.org/nonav/docs/manual/bk03ch05s02.html -->
2156 <if><bool><not><islessthan arg1="${tomcat.version.major}" arg2="7"/></not></bool>
2157 <copy file="${basedir}/resources/tomcat/root_context.xml.in" tofile="${packages.home}/tomcat/conf/context.xml" overwrite="true" />
2158 </if>
2159
2160
2161 <!--
2162 <copy file="${basedir}/resources/tomcat/setclasspath.bat"
2163 tofile="${packages.home}/tomcat/bin/setclasspath.bat"
2164 overwrite="true"/>
2165 <copy file="${basedir}/resources/tomcat/setclasspath.sh"
2166 tofile="${packages.home}/tomcat/bin/setclasspath.sh"
2167 overwrite="true"/>
2168 -->
2169 <!-- make sure we have execute permission for the .sh files -->
2170 <chmod dir="${packages.home}/tomcat/bin" perm="ugo+rx"
2171 includes="*.sh"/>
2172
2173 <echo file="${packages.home}/tomcat/.flagfile">
2174 the timestamp of this file is the time that tomcat was extracted from the zip files.
2175 it is used to figure out whether the files need to be refreshed or not in `ant prepare-tomcat`
2176 </echo>
2177
2178 <!-- this is not strictly a prepare tomcat thing, but if one changes
2179 Java, then they need to change tomcat as well, so might as well call
2180 it here -->
2181 <antcall target="configure-java-version"/>
2182 <else>
2183 <echo>Tomcat has been prepared, will not prepare</echo>
2184 <echo>Delete ${packages.home}/tomcat/.flagfile to force refresh</echo>
2185 </else>
2186
2187 </if>
2188
2189 </target>
2190
2191 <target name="configure-tomcat" depends="init,configure-tomcat-local,configure-tomcat-external"/>
2192
2193 <target name="configure-tomcat-local" depends="init,perl-for-building" if="tomcat.islocal">
2194 <!-- re-setup the server.xml file -->
2195 <copy file="${basedir}/resources/tomcat/server_tomcat${tomcat.version.major}.xml.in"
2196 tofile="${packages.home}/tomcat/conf/server.xml" overwrite="true">
2197 <filterset>
2198 <filter token="shutdown-port" value="${tomcat.shutdown.port}"/>
2199 <filter token="tomcat.ajp.port" value="${tomcat.ajp.port}"/>
2200 <filter token="https.redirect.port" value="${https.redirect.port}"/>
2201 <filter token="localhost.port.http" value="${localhost.port.http}"/>
2202 <filter token="tomcat.port.https" value="${tomcat.port.https}"/>
2203 <!-- Relative path preferred for keystore.file, in case tomcat is moved elsewhere -->
2204 <!--<filter token="keystore.file" value="conf/https_cert/${tomcat.server}.jks" />-->
2205 <!--ON UNIX: <filter token="keystore.file" value="conf/https_cert/fullchain_and_prvtkey.p12" />-->
2206 <!--ON WINDOWS: <filter token="keystore.file" value="conf/https_cert/fullchain_and_prvtkey.pfx" />-->
2207 <filter token="keystore.file" value="conf/https_cert/${keystore.file}" />
2208 <!-- tomcat Connector's keystoreType param defaults to JKS (Java keystore), see https://tomcat.apache.org/tomcat-7.0-doc/config/http.html
2209 We'll follow the instructions at https://community.letsencrypt.org/t/using-lets-encrypt-with-tomcat/41082,
2210 https://www.ssl.com/how-to/create-a-pfx-p12-certificate-file-using-openssl/
2211 and https://computingforgeeks.com/tomcat-7-with-letsencrypt-ssl-certificate/
2212 (minus the keytool step) and use the PKCS12 file generated by openssl directly,
2213 instead of an additional step to generate the java keystore file from that -->
2214 <filter token="keystore.type" value="PKCS12"/>
2215 <filter token="keystore.pass" value="${keystore.pass}"/>
2216 <!--
2217 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)
2218 In that case, see https://serverfault.com/questions/218666/how-to-configure-tomcat-to-only-listen-to-127-0-0-1
2219 -->
2220 <filter token="http.address.restriction" value="${http.address.restriction}"/>
2221 <filter token="https.comment.out.start" value="${https.comment.out.start}"/>
2222 <filter token="https.comment.out.end" value="${https.comment.out.end}"/>
2223 </filterset>
2224 </copy>
2225
2226 <!-- set up the solr context -->
2227
2228 <!-- First work out the IPv4 address for this machine -->
2229 <exec executable="${basedir}/bin/script/IPv4.sh" os="${os.unix}" failonerror="false" outputproperty="ipv4.val">
2230 <arg value="-format-for-tomcat-context"/>
2231 </exec>
2232 <exec executable="${basedir}/bin/script/IPv4.bat" osfamily="windows" failonerror="false" outputproperty="ipv4.val">
2233 <arg value="-format-for-tomcat-context"/>
2234 </exec>
2235
2236 <copy file="${basedir}/ext/solr/solr-tomcat-context.xml.in" tofile="${packages.home}/tomcat/conf/Catalina/localhost/solr.xml" overwrite="true">
2237 <filterset>
2238 <filter token="solr.context" value="${solr.context}"/>
2239 <filter token="gsdl3webhome" value="${web.writablehome}"/>
2240 <filter token="tomcathome" value="${basedir}/packages/tomcat"/>
2241 <filter token="IPv4" value="${ipv4.val}"/>
2242 </filterset>
2243 </copy>
2244
2245 <!-- set up the greenstone3 context, it may have a custom name specified in build.properties -->
2246 <if><bool><not><equals arg1="greenstone3" arg2="${greenstone.context}"></equals></not></bool>
2247 <copy file="${basedir}/resources/tomcat/greenstone3.xml.in" tofile="${basedir}/resources/tomcat/${greenstone.context}.xml.in" overwrite="true"/>
2248 </if>
2249 <copy file="${basedir}/resources/tomcat/${greenstone.context}.xml.in" tofile="${packages.home}/tomcat/conf/Catalina/localhost/${greenstone.context}.xml" overwrite="true">
2250 <filterset>
2251 <filter token="gsdl3webhome" value="${web.home}"/>
2252 <filter token="gsdl3webwritablehome" value="${web.writablehome}"/>
2253 <filter token="privilegedattribute" value="${privileged.attribute}"/>
2254 <filter token="allowedIPs" value="${allowed.IPs}"/>
2255 <filter token="derbyserver" value="${derby.server}"/>
2256 <filter token="derbyserverport" value="${derby.server.port}"/>
2257 </filterset>
2258 </copy>
2259 <if>
2260 <bool>
2261 <and>
2262 <available file="${packages.home}/tomcat/conf/Catalina/localhost/greenstone3.xml"/>
2263 <not><equals arg1="greenstone3" arg2="${greenstone.context}"></equals></not>
2264 </and>
2265 </bool>
2266 <delete file="${packages.home}/tomcat/conf/Catalina/localhost/greenstone3.xml"/>
2267 </if>
2268
2269 <!-- set up the greenstone3 web.xml file -->
2270 <copy file="${basedir}/resources/tomcat/web8.xml.in" tofile="${packages.home}/tomcat/conf/web.xml" overwrite="true">
2271 <filterset>
2272 <filter token="perlpath" value="${perl.path}"/>
2273 </filterset>
2274 </copy>
2275 </target>
2276
2277 <target name="configure-tomcat-external" depends="init" unless="tomcat.islocal">
2278 <!-- re-setup the server.xml file -->
2279 <!-- need to edit the config file, or do we get the user to do this???-->
2280 </target>
2281
2282 <target name="configure-solr-ext" depends="init" >
2283 <!-- re-setup the web/ext/solr/solr.xml file -->
2284 <copy file="${web.home}/ext/solr/solr.xml.in"
2285 tofile="${gsdl3.writablehome}/ext/solr/solr.xml" filtering="true" overwrite="true">
2286 <filterset>
2287 <filter token="gsdl3.home" value="${src.gsdl3.home.unix}"/>
2288 <filter token="gsdl3.writablehome" value="${src.gsdl3.writablehome.unix}"/>
2289 </filterset>
2290 </copy>
2291 </target>
2292
2293 <!-- This target runs tomcat's "bin/catalina.bat(.sh) jpda start"
2294 to allow debugging the running GS3 server in Eclipse. See the instructions at
2295 http://www.wikijava.org/wiki/Debugging_a_servlet_with_tomcat_and_Eclipse_tutorial
2296 on how to use this with eclipse
2297 -->
2298 <target name="debug-start-tomcat" description="Startup Tomcat for debugger" depends="init" if="tomcat.islocal">
2299 <property name="tomcat.classpath" refid="local.tomcat.classpath"/>
2300 <property name="tomcat.path" refid="local.tomcat.path"/>
2301
2302 <if><bool>
2303 <isset property="fedora.maxpermsize"/></bool>
2304 <property name="catalina.opts" value="-Djava.util.prefs.syncInterval=2000000 -DGSDL3HOME=$GSDL3HOME -DGSDLOS=$GSDLOS -DPATH=$PATH -Xmx800M ${readonly.catalina.opts} ${fedora.maxpermsize}"/>
2305 <else>
2306 <property name="catalina.opts" value="-Djava.util.prefs.syncInterval=2000000 -DGSDL3HOME=$GSDL3HOME -DGSDLOS=$GSDLOS -DPATH=$PATH -Xmx800M ${readonly.catalina.opts}"/>
2307 </else>
2308 </if>
2309
2310 <echo file="${catalina.home}/bin/setenv.bat">set CLASSPATH=${tomcat.classpath}</echo>
2311 <echo file="${catalina.home}/bin/setenv.sh">export CLASSPATH=${tomcat.classpath}</echo>
2312
2313 <exec executable="${catalina.home}/bin/catalina.sh" os="${os.unix}" dir="${catalina.home}/bin" spawn="false">
2314 <arg value="jpda" />
2315 <arg value="start" />
2316 <env key="JPDA_ADDRESS" value="8000"/> <!-- for debugging Tomcat in Eclipse -->
2317 <env key="JPDA_TRANSPORT" value="dt_socket"/> <!-- for debugging Tomcat in Eclipse -->
2318 <!--<env key="GSDLOS" value="linux"/> do we need this?? -->
2319 <env key="PATH" path="${tomcat.path}"/>
2320 <env key="CATALINA_OPTS" value="${catalina.opts}"/>
2321 <env key="CATALINA_HOME" value="${catalina.home}"/>
2322 <env key="CLASSPATH" path="${tomcat.classpath}"/>
2323 <env key="LD_LIBRARY_PATH" path="${env.LD_LIBRARY_PATH}:${lib.jni}"/>
2324 <env key="DYLD_LIBRARY_PATH" path="${env.DYLD_LIBRARY_PATH}:${lib.jni}:${gdbm.home}/lib"/> <!-- for mac os --> <!-- need gdbm here these days ??-->
2325 <env key="WNHOME" path="${wn.home}"/>
2326 <env key="FEDORA_HOME" path="${fedora.home}"/>
2327 </exec>
2328 <exec executable="${catalina.home}/bin/catalina.bat" osfamily="windows" dir="${catalina.home}/bin" spawn="true">
2329 <arg value="jpda" />
2330 <arg value="start" />
2331 <env key="JPDA_ADDRESS" value="8000"/> <!-- for debugging Tomcat in Eclipse -->
2332 <env key="JPDA_TRANSPORT" value="dt_socket"/> <!-- for debugging Tomcat in Eclipse -->
2333 <env key="GSDLOS" value="windows"/>
2334 <env key="GSDL3HOME" value="${basedir}"/>
2335 <env key="Path" path="${tomcat.path}"/>
2336 <env key="PATH" path="${tomcat.path}"/>
2337 <env key="CATALINA_OPTS" value="${catalina.opts}"/>
2338 <env key="CATALINA_HOME" value="${catalina.home}"/>
2339 <env key="CLASSPATH" path="${tomcat.classpath}"/>
2340 <env key="FEDORA_HOME" path="${fedora.home}"/>
2341 </exec>
2342 <!-- wait for the server to startup in case other targets need it running -->
2343 <waitfor maxwait="5" maxwaitunit="second">
2344 <and>
2345 <socket server="${tomcat.server}" port="${default.tomcat.port}"/>
2346 <!--<http url="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}/index.html"/>-->
2347 <http url="${local.http.url}${app.path}/index.html"/>
2348 </and>
2349 </waitfor>
2350 </target>
2351
2352 <target name="start-tomcat" description="Startup only Tomcat" depends="check-tomcat-started">
2353
2354 <if><bool><istrue value="${tomcat.isstarted}"/></bool>
2355 <echo>**************************************</echo>
2356 <echo>A WEB SERVER IS ALREADY RUNNING ON ${default.server.protocol}://${tomcat.server}:${default.tomcat.port} (${local.http.url}). NOT STARTING.</echo>
2357 <echo>**************************************</echo>
2358 <else>
2359 <antcall target="force-start-tomcat"/>
2360 </else>
2361 </if>
2362 </target>
2363
2364 <!-- Another way: http://ptrthomas.wordpress.com/2006/03/25/how-to-start-and-stop-tomcat-from-ant/ -->
2365 <target name="force-start-tomcat" description="Startup only Tomcat" depends="init" if="tomcat.islocal">
2366
2367 <property name="tomcat.classpath" refid="local.tomcat.classpath"/>
2368 <property name="tomcat.path" refid="local.tomcat.path"/>
2369
2370 <if><bool>
2371 <isset property="fedora.maxpermsize"/></bool>
2372 <property name="catalina.opts" value="-Djava.util.prefs.syncInterval=2000000 -DGSDL3HOME=$GSDL3HOME -DGSDLOS=$GSDLOS -DPATH=$PATH -Xmx800M ${readonly.catalina.opts} ${fedora.maxpermsize}"/>
2373 <else>
2374 <property name="catalina.opts" value="-Djava.util.prefs.syncInterval=2000000 -DGSDL3HOME=$GSDL3HOME -DGSDLOS=$GSDLOS -DPATH=$PATH -Xmx800M ${readonly.catalina.opts}"/>
2375 </else>
2376 </if>
2377
2378 <echo file="${catalina.home}/bin/setenv.bat">set CLASSPATH=${tomcat.classpath}</echo>
2379 <echo file="${catalina.home}/bin/setenv.sh">export CLASSPATH=${tomcat.classpath}</echo>
2380
2381 <!-- using osfamily instead of testing os against os.windows list of recognised windows versions
2382 so that future windows versions are included. See http://simonharrer.wordpress.com/tag/osfamily/
2383 Can't use the osfamily test for linux-type machines as a group since osfamily=unix is separate from osfamily=mac,
2384 see http://ant-contrib.sourceforge.net/tasks/tasks/osfamily.html -->
2385
2386 <!--<exec executable="${catalina.home}/bin/startup.sh" os="${os.unix}" dir="${catalina.home}/bin" spawn="false">-->
2387 <exec executable="${sudo.or.not}" os="${os.unix}" dir="${catalina.home}/bin" spawn="false">
2388 <!--<env key="GSDLOS" value="linux"/> do we need this?? -->
2389 <env key="GSDL3HOME" value="${basedir}"/>
2390 <env key="PATH" path="${tomcat.path}"/>
2391 <env key="CATALINA_OPTS" value="${catalina.opts}"/>
2392 <env key="CATALINA_HOME" value="${catalina.home}"/>
2393 <env key="CLASSPATH" path="${tomcat.classpath}"/>
2394 <env key="LD_LIBRARY_PATH" path="${env.LD_LIBRARY_PATH}:${lib.jni}"/>
2395 <env key="DYLD_LIBRARY_PATH" path="${env.DYLD_LIBRARY_PATH}:${lib.jni}:${gdbm.home}/lib"/> <!-- for mac os --> <!-- need gdbm here these days ??-->
2396 <env key="WNHOME" path="${wn.home}"/>
2397 <env key="FEDORA_HOME" path="${fedora.home}"/>
2398 <arg value="${catalina.home}/bin/startup.sh"/>
2399 </exec>
2400 <exec executable="${catalina.home}/bin/startup.bat" osfamily="windows" dir="${catalina.home}/bin" spawn="true">
2401 <env key="GSDLOS" value="windows"/>
2402 <env key="GSDL3HOME" value="${basedir}"/>
2403 <env key="Path" path="${tomcat.path}"/>
2404 <env key="PATH" path="${tomcat.path}"/>
2405 <env key="CATALINA_OPTS" value="${catalina.opts}"/>
2406 <env key="CATALINA_HOME" value="${catalina.home}"/>
2407 <env key="CLASSPATH" path="${tomcat.classpath}"/>
2408 <env key="FEDORA_HOME" path="${fedora.home}"/>
2409 </exec>
2410 <!-- wait for the server to startup in case other targets need it running -->
2411 <waitfor maxwait="5" maxwaitunit="second">
2412 <and>
2413 <socket server="${tomcat.server}" port="${default.tomcat.port}"/>
2414 <!--<http url="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}/index.html"/>-->
2415 <http url="${local.http.url}${app.path}/index.html"/>
2416 </and>
2417 </waitfor>
2418
2419 </target>
2420
2421 <!--ant task http: http://www.jajakarta.org/ant/ant-1.6.1/docs/ja/manual/api/org/apache/tools/ant/taskdefs/condition/Http.html-->
2422 <target name="reconfigure" description="Reconfigure the message router">
2423 <waitfor maxwait="5" maxwaitunit="second">
2424 <!--<http url="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}${server.default.servlet}?a=s&amp;sa=c"/>-->
2425 <http url="${local.http.url}${app.path}${server.default.servlet}?a=s&amp;sa=c"/>
2426 </waitfor>
2427 </target>
2428
2429 <!--Command-line args to Ant: http://www.jguru.com/faq/view.jsp?EID=471794-->
2430 <target name="reconfigure-collection" description="Reconfigure the collection">
2431 <waitfor maxwait="5" maxwaitunit="second">
2432 <!--<http url="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}${server.default.servlet}?a=s&amp;sa=c&amp;sc=${collection}"/>-->
2433 <http url="${local.http.url}${app.path}${server.default.servlet}?a=s&amp;sa=c&amp;sc=${collection}"/>
2434 </waitfor>
2435 </target>
2436
2437 <!-- windows: do we want to launch a webrowser?? -->
2438 <!-- shouldn't this test whether anything is running first?
2439 It's safer to always attempt to stop tomcat: that way we won't be dependent on the right time
2440 to check whether the server is stopped or still running before attempting to start again.
2441 This target, which was recently called force-stop-tomcat for a while but is back to being
2442 called stop-tomcat, now hides the Java exception output that appears whenever tomcat is already
2443 stopped as happens when stop-tomcat is called consecutively. -->
2444 <target name="force-stop-tomcat" description="Shutdown only Tomcat" depends="init" if="tomcat.islocal">
2445 <!--<exec executable="${catalina.home}/bin/shutdown.sh" os="${os.unix}" dir="${catalina.home}/bin" spawn="false">-->
2446 <exec executable="${sudo.or.not}" os="${os.unix}" dir="${catalina.home}/bin" spawn="false">
2447 <env key="FEDORA_HOME" path="${fedora.home}"/>
2448 <env key="CATALINA_HOME" value="${catalina.home}"/>
2449 <arg value="${catalina.home}/bin/shutdown.sh"/>
2450 <arg line=">/dev/null 2>&amp;1"/>
2451 </exec>
2452 <exec executable="${catalina.home}/bin/shutdown.bat" osfamily="windows" dir="${catalina.home}/bin" spawn="false">
2453 <env key="FEDORA_HOME" path="${fedora.home}"/>
2454 <env key="CATALINA_HOME" value="${catalina.home}"/>
2455 <arg line=">nul 2>&amp;1"/>
2456 </exec>
2457 </target>
2458
2459 <!-- Can also try the "socket" condition in place of the "http" condition
2460 And also use a <waitfor> in place of <condition>, such as:
2461 <waitfor maxwait="5" maxwaitunit="second" timeoutproperty="tomcat.isstopped"><http url="..."/></waitfor>
2462 The http URL resolves to host:port/greenstone3
2463 Condition uses <http/> rather than <socket/> for testing, since if the server was stopped, the socket
2464 might still be in use for some moments. We test the URL with the http condition since it's likelier to
2465 fail sooner if the server has indeed been stopped. -->
2466 <target name="check-tomcat-running">
2467 <condition property="tomcat.isrunning">
2468 <!--<http url="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}"/>-->
2469 <!--<http url="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}"/>--><!-- untrusted certificates won't work, so don't test https urls-->
2470 <http url="${local.http.url}"/><!-- testing the local http url instead -->
2471 </condition>
2472 </target>
2473
2474 <!--
2475 <target name="verbose-check-tomcat-running">
2476 <condition property="tomcat.isrunning" value="true" else="false">
2477 <http url="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}"/>
2478 <http url="${local.http.url}"/>
2479 </condition>
2480 <echo>Tomcat is running: ${tomcat.isrunning}</echo>
2481 </target>
2482 -->
2483 <target name="verbose-check-tomcat-running" depends="check-tomcat-running">
2484 <if>
2485 <bool>
2486 <istrue value="${tomcat.isrunning}"/>
2487 </bool>
2488 <echo>Tomcat is running: ${tomcat.isrunning}</echo>
2489 <else><echo>Tomcat is running: false</echo></else><!-- tomcat.isrunning not set -->
2490 </if>
2491 </target>
2492
2493 <!-- Need a copy of the check-tomcat-running target with a distinct property, because ant restart runs
2494 both stop and start, both of which need to do tomcat checks. Each property can be set only once during
2495 an invocation with ant. So ant restart will need two properties to store each of the tomcat checks -->
2496 <target name="check-tomcat-started">
2497 <condition property="tomcat.isstarted">
2498 <!--<http url="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}"/>-->
2499 <http url="${local.http.url}"/>
2500 </condition>
2501 </target>
2502
2503
2504
2505 <!-- stop-tomcat checks if the tomcat server is already running. If it appears to be running
2506 (regardless of whether tomcat was just starting to shut down), this target calls force-stop-tomcat
2507 to issue the shutdown command to tomcat. Then it waits for at most 15 seconds for the server to
2508 actually stop by checking the socket at which tomcat listens every second, printing a warning
2509 at the end of the max wait time of 15 seconds if tomcat was still running. -->
2510 <target name="stop-tomcat" description="Shutdown only Tomcat if running" depends="check-tomcat-running" if="tomcat.isrunning">
2511 <antcall target="force-stop-tomcat"/>
2512
2513 <property name="wait.numchecks" value="15"/>
2514 <echo>Waiting for the server to shutdown... (${wait.numchecks} seconds max)</echo>
2515 <waitfor maxwait="${wait.numchecks}" maxwaitunit="second" checkevery="1" checkeveryunit="second" timeoutproperty="tomcat.timedout">
2516 <not><socket server="${tomcat.server}" port="${default.tomcat.port}"/></not>
2517 </waitfor>
2518
2519 <if>
2520 <bool>
2521 <isset property="${tomcat.timedout}"/>
2522 </bool>
2523 <property name="tomcat.isrunning" value="true"/>
2524 <echo>WARNING: Checked the socket ${wait.numchecks} times, but port ${default.tomcat.port} is still busy.</echo>
2525 <else>
2526 <echo>Tomcat is stopped.</echo>
2527 <property name="tomcat.isrunning" value="false"/>
2528 </else>
2529 </if>
2530 </target>
2531
2532 <target name="restart-tomcat" description="Shutdown and restart only Tomcat" depends="init,stop-tomcat,force-start-tomcat"/>
2533
2534 <target name="setup-catalina-ant-tasks">
2535 <!-- Configure the custom Ant tasks for the Tomcat Manager application -->
2536 <taskdef name="deploy" classname="org.apache.catalina.ant.DeployTask"
2537 classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
2538 <taskdef name="list" classname="org.apache.catalina.ant.ListTask"
2539 classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
2540 <taskdef name="reload" classname="org.apache.catalina.ant.ReloadTask"
2541 classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
2542 <taskdef name="resources" classname="org.apache.catalina.ant.ResourcesTask"
2543 classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
2544 <taskdef name="roles" classname="org.apache.catalina.ant.RolesTask"
2545 classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
2546 <taskdef name="start" classname="org.apache.catalina.ant.StartTask"
2547 classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
2548 <taskdef name="stop" classname="org.apache.catalina.ant.StopTask"
2549 classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
2550 <taskdef name="undeploy" classname="org.apache.catalina.ant.UndeployTask"
2551 classpath="${catalina.home}/server/lib/catalina-ant.jar"/>
2552 </target>
2553
2554 <!-- http://blog.andrewbeacock.com/2007/11/how-to-truncate-log-file-using-ubuntu.html
2555 Doing "cat </dev/null > packages/tomcat/logs/catalina.out" doesn't work as an ant target.
2556 It seems to have a problem with cat or </dev/null, with or without the < sign. -->
2557 <target name="reset-logs" description="Empties catalina.out, greenstone.log and contents of web/logs/tmp">
2558 <echo>Truncating catalina.out, solr.log, greenstone.log and server.log, and emptying ${web.writablehome}/logs/tmp</echo>
2559 <exec executable="rm" os="${os.unix}" dir="${catalina.home}/logs" spawn="false">
2560 <arg value="-f"/>
2561 <arg value="catalina.out"/>
2562 </exec>
2563 <exec executable="rm" os="${os.unix}" dir="${web.writablehome}/logs" spawn="false">
2564 <arg value="-f"/>
2565 <arg value="greenstone.log"/>
2566 </exec>
2567 <exec executable="rm" os="${os.unix}" dir="${web.writablehome}/logs" spawn="false">
2568 <arg value="-f"/>
2569 <arg value="server.log"/>
2570 </exec>
2571
2572 <exec executable="touch" os="${os.unix}" dir="${catalina.home}/logs"
2573 spawn="false">
2574 <arg value="catalina.out"/>
2575 </exec>
2576 <exec executable="touch" os="${os.unix}" dir="${web.writablehome}/logs"
2577 spawn="false">
2578 <arg value="greenstone.log"/>
2579 </exec>
2580 <exec executable="touch" os="${os.unix}" dir="${web.writablehome}/logs"
2581 spawn="false">
2582 <arg value="server.log"/>
2583 </exec>
2584
2585 <exec executable="cmd" osfamily="windows" dir="${catalina.home}/logs" spawn="false">
2586 <arg line="/c echo. > catalina.out"/>
2587 </exec>
2588 <exec executable="cmd" osfamily="windows" dir="${web.writablehome}/logs" spawn="false">
2589 <arg line="/c echo. > greenstone.log"/>
2590 </exec>
2591 <exec executable="cmd" osfamily="windows" dir="${web.writablehome}/logs" spawn="false">
2592 <arg line="/c echo. > server.log"/>
2593 </exec>
2594
2595 <!-- if ext/solr/logs/solr.log exists, truncate it -->
2596 <if><bool><available file="${solr-ext.home}/logs/solr.log" type="file"/></bool>
2597 <exec executable="rm" os="${os.unix}" dir="${solr-ext.home}/logs" spawn="false">
2598 <arg value="-f"/>
2599 <arg value="solr.log"/>
2600 </exec>
2601 <exec executable="touch" os="${os.unix}" dir="${solr-ext.home}/logs" spawn="false">
2602 <arg value="solr.log"/>
2603 </exec>
2604 <exec executable="cmd" osfamily="windows" dir="${solr-ext.home}/logs" spawn="false">
2605 <arg line="/c echo. > solr.log"/>
2606 </exec>
2607 </if>
2608
2609 <if>
2610 <bool><available file="${web.writablehome}/logs/tmp" type="dir"/></bool>
2611 <delete>
2612 <fileset dir="${web.writablehome}/logs/tmp" includes="**/*"/>
2613 </delete>
2614 </if>
2615 </target>
2616
2617 <target name="clear-tomcat-sessions" description="Clear the Tomcat Session info." depends="init">
2618 <exec executable="cmd" osfamily="windows" dir="${catalina.home}/work/Catalina/localhost/greenstone3" spawn="false">
2619 <arg line="/c echo. > SESSIONS.ser"/>
2620 </exec>
2621 <exec executable="rm" os="${os.unix}" dir="${catalina.home}/work/Catalina/localhost/greenstone3" spawn="false">
2622 <arg value="-f"/>
2623 <arg value="SESSIONS.ser"/>
2624 </exec>
2625
2626 </target>
2627 <!-- ======================= ant Targets ============================ -->
2628 <target name="prepare-ant" depends="init">
2629 <if>
2630 <bool>
2631 <not><available file="${packages.home}/ant/.flagfile"/></not>
2632 </bool>
2633 <property name="ant.download.version" value="apache-ant-1.9.13" />
2634 <get src="http://www.greenstone.org/gs3files/${ant.download.version}-bin.zip"
2635 dest="${packages.home}/${ant.download.version}-bin.zip"
2636 usetimestamp="true"/>
2637 <unzip src="${packages.home}/${ant.download.version}-bin.zip"
2638 dest="${packages.home}"/>
2639 <move todir="${packages.home}/ant">
2640 <fileset dir="${packages.home}/${ant.download.version}"/>
2641 </move>
2642 <echo file="${packages.home}/ant/.flagfile">
2643 the timestamp of this file is the time that ant was extracted from the zip files.
2644 it is used to figure out whether the files need to be refreshed or not in `ant prepare-ant`
2645 </echo>
2646
2647 <else>
2648 <echo>Ant has been prepared, will not prepare</echo>
2649 <echo>Delete ${packages.home}/ant/.flagfile to force refresh</echo>
2650 </else>
2651
2652 </if>
2653 </target>
2654
2655 <!-- ======================= Admin Targets ============================ -->
2656
2657 <!-- This target won't work with Eclipse because the SecureInputHandler used below conflicts with it.
2658 See http://www.dcepler.net/post.cfm/hiding-password-input-in-ant
2659 But you can do: echo mypassword | ant config-admin -->
2660 <target name="config-admin" description="Reset admin password">
2661 <input addproperty="admin.password" defaultvalue="admin" message="New admin password (3-20 characters):&gt;">
2662 <handler classname="org.apache.tools.ant.input.SecureInputHandler" /> <!-- password won't be visible on screen -->
2663 </input>
2664 <!--<echo>PWD: ${admin.password}</echo>-->
2665 <antcall target="update-userdb">
2666 <param name="user.username" value="admin"/>
2667 <param name="user.password" value="${admin.password}"/>
2668 <param name="user.groups" value=""/>
2669 <param name="user.status" value=""/>
2670 <param name="user.comment" value="Password updated."/>
2671 <param name="user.email" value=""/>
2672 </antcall>
2673 </target>
2674
2675 <target name="config-user" description="Add or modify users" depends="get-user-data,update-userdb"/>
2676
2677 <target name="get-user-data" description="Get user details">
2678 <input addproperty="user.username" message="Username:&gt;"/>
2679 <input addproperty="user.password" defaultvalue="" message="Password (3-20 characters):&gt;">
2680 <handler classname="org.apache.tools.ant.input.SecureInputHandler" /> <!-- password won't be visible on screen -->
2681 </input>
2682 <input addproperty="user.groups" defaultvalue="" message="Groups (comma-separated list, e.g. personal-collections-editor):&gt;"/>
2683 <input addproperty="user.status" defaultvalue="true" message="Enabled (true/false):&gt;"/>
2684 <input addproperty="user.comment" defaultvalue="" message="Comment:&gt;"/>
2685 <input addproperty="user.email" defaultvalue="" message="Email:&gt;"/>
2686 </target>
2687
2688 <!-- This target won't work with Eclipse because the SecureInputHandler used below conflicts with it.
2689 See http://www.dcepler.net/post.cfm/hiding-password-input-in-ant
2690 But you can do: echo mypassword | ant config-admin -->
2691 <target name="update-userdb" description="Add or modify users" depends="start-derby">
2692
2693 <!--
2694 We're now using derby networked server, so stopping and starting tomcat is not necessary.
2695 For embedded derby: stop tomcat if running, since derby db is embedded
2696 and only allows connections from one jvm instance at a time
2697 See http://db.apache.org/derby/papers/DerbyTut/embedded_intro.html
2698 The ${tomcat.isrunning} property is set by the depends-target "check-tomcat-running" -->
2699
2700 <!-- Need the derby networked server to be running in order to modify the usersDB.
2701 The start-derby task will check if derby is already running (if not, ${derby.isstarted} will
2702 be false) and will only start up networked derby if it is not already running.
2703 The ${derby.isstarted} property is set by the depends-target "start-derby", since it won't
2704 set the property if called with antcall (like launching in a subshell). Have to use 'depends'.
2705 We'll check ${derby.isstarted} at the end to stop derby again if we had to start it up now.-->
2706 <!--<antcall target="start-derby"/>-->
2707
2708 <!-- wait a max of 5 seconds for the derbyserver to have started up -->
2709 <waitfor maxwait="5" maxwaitunit="second">
2710 <socket server="${derby.server}" port="${derby.server.port}"/>
2711 </waitfor>
2712
2713 <!--<echo>${admin.password}</echo>--> <!-- for testing -->
2714 <echo>gsdl3.writablehome: ${gsdl3.writablehome}</echo> <!-- for testing -->
2715 <echo>web.home: ${web.home}</echo> <!-- for testing -->
2716 <java classname="org.greenstone.gsdl3.util.ModifyUsersDB">
2717 <classpath refid="compile.classpath"/> <!--for ${web.lib}/gsdl3.jar and supporting files-->
2718 <sysproperty key="gsdl3.writablehome" value="${gsdl3.writablehome}" /> <!-- passes -D<syspropKey=syspropVal> to java class ModifyUsersDB. Available in java code as System.getProperty("syspropKey") -->
2719 <arg file="${web.home}/etc/usersDB"/>
2720 <arg value="${user.username}"/>
2721 <arg value="password=${user.password}"/>
2722 <arg value="groups=${user.groups}"/>
2723 <arg value="status=${user.status}"/>
2724 <arg value="comment=${user.comment}"/>
2725 <arg value="email=${user.email}"/>
2726 </java>
2727
2728 <!-- Need to stop networked derby again if we ran it for this target with the depends=start-derby call.
2729 The test here is for <not>derby.isstarted</not>, as the property would be the same as before
2730 derby was started, since properties are immutable within a single ant command. -->
2731 <if>
2732 <bool>
2733 <not><istrue value="${derby.isstarted}"/></not>
2734 </bool>
2735 <antcall target="force-stop-derby"/>
2736 </if>
2737
2738 </target>
2739
2740
2741 <!-- ======================= Axis Targets ============================ -->
2742
2743 <target name="prepare-axis" depends="init">
2744
2745 <if>
2746 <bool>
2747 <not><available file="${packages.home}/axis/.flagfile"/></not>
2748 </bool>
2749
2750 <get src="http://www.greenstone.org/gs3files/${axis.zip.version}"
2751 dest="${packages.home}/${axis.zip.version}"
2752 usetimestamp="true"/>
2753 <unzip src="${packages.home}/${axis.zip.version}"
2754 dest="${packages.home}"/>
2755 <move todir="${packages.home}/axis">
2756 <fileset dir="${packages.home}/${axis.dir.version}"/>
2757 </move>
2758 <!-- install axis into greenstone web app -->
2759 <copy todir="${web.lib}">
2760 <fileset dir="${packages.home}/axis/webapps/axis/WEB-INF/lib">
2761 <include name="*.jar"/>
2762 </fileset>
2763 </copy>
2764 <copy todir="${web.home}">
2765 <fileset dir="${packages.home}/axis/webapps/axis/">
2766 <include name="*.jsp"/>
2767 <include name="*.jws"/>
2768 </fileset>
2769 </copy>
2770 <copy tofile="${web.home}/axis.html" file="${packages.home}/axis/webapps/axis/index.html"/>
2771 <copy todir="${web.classes}">
2772 <fileset dir="${packages.home}/axis/webapps/axis/WEB-INF/classes">
2773 <include name="*.properties"/>
2774 </fileset>
2775 </copy>
2776 <echo file="${packages.home}/axis/.flagfile">
2777 the timestamp of this file is the time that axis was extracted from the zip files.
2778 it is used to figure out whether the files need to be refreshed or not in `ant prepare-axis`
2779 </echo>
2780
2781 <else>
2782 <echo>Axis has been prepared, will not prepare</echo>
2783 <echo>Delete ${packages.home}/axis/.flagfile to force refresh</echo>
2784 </else>
2785
2786 </if>
2787 </target>
2788
2789 <target name="soap-deploy-site" depends="init,get-sitename,get-siteuri,get-webservices,create-deployment-files,deploy-site"
2790 description="Deploy a SOAP web service for a local Greenstone site. Tomcat must be running for this to work."/>
2791
2792 <target name="deploy-site">
2793 <java classname="org.apache.axis.client.AdminClient">
2794 <classpath refid="compile.classpath"/>
2795 <arg value="-l"/>
2796 <arg value="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}/servlet/AxisServlet"/>
2797 <arg file="${basedir}/resources/soap/deploy.wsdd"/>
2798 </java>
2799 <delete file="${basedir}/resources/soap/deploy.wsdd"/> <!--clean up, no longer used-->
2800 </target>
2801
2802 <target name="soap-undeploy-site" depends="get-undeploy-service-name"
2803 description="Undeploy a SOAP web service for a local Greenstone site. Tomcat must be running for this to work.">
2804 <filter token="servicesname" value="${axis.undeploy.servicename}"/>
2805 <copy file="${basedir}/resources/soap/undeploy-site.wsdd.template"
2806 tofile="${basedir}/resources/soap/undeploy.wsdd"
2807 filtering="true"
2808 overwrite="true"/>
2809 <java classname="org.apache.axis.client.AdminClient">
2810 <classpath refid="compile.classpath"/>
2811 <arg value="-l"/>
2812 <arg value="${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}/servlet/AxisServlet"/>
2813 <arg file="${basedir}/resources/soap/undeploy.wsdd"/>
2814 </java>
2815 <delete file="${basedir}/resources/soap/undeploy.wsdd"/> <!--clean up, no longer used-->
2816 </target>
2817
2818 <!-- this target used to deploy the default web service SOAPServer (base.webservice.name) on the localsite server
2819 with the default servicename of localsite-->
2820 <target name="deploy-localsite" depends="init"
2821 description="Deploy the SOAP server for localsite. Will start and stop Tomcat.">
2822 <antcall target="force-start-tomcat"/>
2823 <echo>Deploying ${base.webservice.name} web services for localsite under service name: localsite</echo>
2824 <antcall target="create-deployment-files">
2825 <param name="axis.sitename" value="localsite"/>
2826 <param name="axis.servicesname" value="${base.webservice.name}"/>
2827 <param name="axis.siteuri" value="localsite"/>
2828 </antcall>
2829 <antcall target="deploy-site">
2830 <param name="axis.sitename" value="localsite"/>
2831 <param name="axis.servicesname" value="${base.webservice.name}"/>
2832 <param name="axis.siteuri" value="localsite"/>
2833 </antcall>
2834 <echo>The Greenstone server has been started up. If you do not want it running, please type: ant stop.</echo>
2835 </target>
2836
2837 <target name="get-sitename" unless="axis.sitename">
2838 <input addproperty="axis.sitename" defaultvalue="localsite">What site do you want to deploy services for?
2839Press Enter for default:localsite</input>
2840 </target>
2841
2842 <target name="get-undeploy-service-name" unless="axis.undeploy.servicename">
2843 <input addproperty="axis.undeploy.servicename" defaultvalue="localsite">Please enter the full name of the service you wish to undeploy.
2844To find out which web services you've got deployed, point your browser to ${default.server.protocol}://${tomcat.server}:${default.tomcat.port}/greenstone3/services
2845Or press Enter for undeploying the default:localsite /&gt;</input>
2846 <echo>Name of service to undeploy: ${axis.undeploy.servicename}</echo>
2847 </target>
2848
2849 <target name="get-webservices" unless="axis.servicesname">
2850 <input addproperty="axis.servicesname" defaultvalue="${base.webservice.name}">Which set of web services do you want to deploy?
2851Choose from: ${web.services.list}
2852Or press Enter for default:${base.webservice.name} /&gt;</input>
2853 <echo>${axis.servicesname}</echo>
2854 </target>
2855
2856 <target name="get-siteuri" depends="get-sitename,get-webservices" unless="axis.siteuri">
2857 <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>
2858 <echo>Site: ${axis.sitename}, services: ${axis.servicesname}, servicesname: ${axis.siteuri}</echo>
2859 </target>
2860
2861 <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">
2862 <condition property="soap.method" value="provider='java:MSG' style='message' use='literal'">
2863 <equals arg1="${axis.servicesname}" arg2="${base.webservice.name}"/>
2864 </condition>
2865
2866 <!--everything else defaults to java:RPC at present-->
2867 <condition property="soap.method" value="provider='java:RPC'">
2868 <not>
2869 <equals arg1="${axis.servicesname}" arg2="${base.webservice.name}"/>
2870 </not>
2871 </condition>
2872 </target>
2873
2874 <target name="create-deployment-files" depends="set-soapmethod" if="axis.sitename">
2875 <filter token="sitename" value="${axis.sitename}"/>
2876 <filter token="siteuri" value="${axis.siteuri}"/>
2877 <filter token="servicesname" value="${axis.servicesname}"/>
2878 <filter token="soapmethod" value="${soap.method}"/>
2879 <copy file="${basedir}/resources/soap/site.wsdd.template"
2880 tofile="${basedir}/resources/soap/deploy.wsdd"
2881 filtering="true"
2882 overwrite="true"/>
2883 <!-- create the java files and compile them -->
2884 <copy file="${basedir}/resources/java/${axis.servicesname}.java.in"
2885 tofile="${src.gsdl3.home}/${axis.servicesname}${axis.sitename}.java"
2886 filtering="true"
2887 overwrite="true"/>
2888 <mkdir dir="${build.home}"/>
2889 <javac srcdir="${src.home}"
2890 destdir="${build.home}"
2891 includeantruntime="${compile.includeantruntime}"
2892 debug="${compile.debug}"
2893 deprecation="${compile.deprecation}"
2894 optimize="${compile.optimize}"
2895 encoding="${compile.encoding}">
2896 <classpath refid="compile.classpath"/>
2897 <include name="org/greenstone/gsdl3/${axis.servicesname}${axis.sitename}.java" />
2898 </javac>
2899 <mkdir dir="${web.classes}/org/greenstone/gsdl3"/>
2900 <copy file="${build.home}/org/greenstone/gsdl3/${axis.servicesname}${axis.sitename}.class"
2901 tofile="${web.classes}/org/greenstone/gsdl3/${axis.servicesname}${axis.sitename}.class"
2902 overwrite="true" />
2903 </target>
2904
2905
2906 <!-- ====================== Core targets ============================== -->
2907 <!-- core targets refer to the core gsdl3 java src -->
2908
2909 <target name="prepare-core"/>
2910
2911 <target name="configure-core"/>
2912
2913 <target name="update-core" depends="init,svnupdate-core,clean-core,compile-core"
2914 description="Update only the Greenstone core" />
2915
2916 <target name="svnupdate-core" unless="nosvn.mode">
2917 <exec executable="svn">
2918 <arg value="update"/>
2919 <arg value="${basedir}"/>
2920 <arg value="-r"/><arg value="${branch.revision}"/>
2921 </exec>
2922 </target>
2923
2924 <target name="clean-core"
2925 description="Clean only the Greenstone core">
2926 <!-- should this delete the gsdl3.jar from web/WEB-INF?? -->
2927 <delete dir="${build.home}"/>
2928 </target>
2929
2930 <target name="compile-core" depends="init"
2931 description="Compile only the Greenstone core">
2932 <mkdir dir="${build.home}"/>
2933
2934 <if><bool><isset property="with.jni"/></bool>
2935 <javac srcdir="${src.home}"
2936 destdir="${build.home}"
2937 includeantruntime="${compile.includeantruntime}"
2938 debug="${compile.debug}"
2939 deprecation="${compile.deprecation}"
2940 optimize="${compile.optimize}"
2941 encoding="${compile.encoding}">
2942 <classpath>
2943 <path refid="compile.classpath"/>
2944 </classpath>
2945 </javac>
2946 <else>
2947 <property name="gsprefix" value=""/>
2948 <javac srcdir="${src.home}"
2949 destdir="${build.home}"
2950 includeantruntime="${compile.includeantruntime}"
2951 debug="${compile.debug}"
2952 deprecation="${compile.deprecation}"
2953 optimize="${compile.optimize}"
2954 encoding="${compile.encoding}">
2955 <classpath>
2956 <path refid="compile.classpath"/>
2957 </classpath>
2958 <exclude name="org/greenstone/gsdl3/service/GS2MGPPRetrieve.java"/>
2959 <exclude name="org/greenstone/gsdl3/service/GS2MGPPSearch.java"/>
2960 <exclude name="org/greenstone/gsdl3/service/GS2MGSearch.java"/>
2961 <exclude name="org/greenstone/gsdl3/service/GS2MGRetrieve.java"/>
2962 <exclude name="org/greenstone/gsdl3/service/GoogleNgramMGPPSearch.java"/>
2963 <exclude name="org/greenstone/gsdl3/service/PhindPhraseBrowse.java"/>
2964 <exclude name="org/greenstone/gsdl3/util/GDBMWrapper.java"/>
2965 </javac>
2966 </else>
2967 </if>
2968 <jar destfile="${build.home}/gsdl3.jar">
2969 <fileset dir="${build.home}">
2970 <include name="org/greenstone/gsdl3/**"/>
2971 <include name="org/flax/**"/>
2972 <exclude name="**/Test.class"/>
2973 </fileset>
2974 <manifest>
2975 <attribute name="Built-By" value="${user.name}" />
2976 </manifest>
2977 </jar>
2978 <copy file="${build.home}/gsdl3.jar" todir="${web.lib}"/>
2979
2980 <jar destfile="${build.home}/gutil.jar">
2981 <fileset dir="${build.home}">
2982 <include name="org/greenstone/util/**"/>
2983 </fileset>
2984 <manifest>
2985 <attribute name="Built-By" value="${user.name}" />
2986 </manifest>
2987 </jar>
2988 <copy file="${build.home}/gutil.jar" todir="${web.lib}"/>
2989
2990 <!-- copy the localsite server in case we need it -->
2991 <copy file="${build.home}/org/greenstone/gsdl3/${base.webservice.name}localsite.class" tofile="${web.classes}/org/greenstone/gsdl3/${base.webservice.name}localsite.class" />
2992
2993 <!-- Greenstone Administrator Interface -->
2994 <jar destfile="${build.home}/GAI.jar">
2995 <fileset dir="${build.home}">
2996 <include name="org/greenstone/admin/**"/>
2997 </fileset>
2998 <manifest>
2999 <attribute name="Built-By" value="${user.name}" />
3000 </manifest>
3001 </jar>
3002 <copy file="${build.home}/GAI.jar" todir="${web.lib}"/>
3003 <copy file="${build.home}/GAI.jar" todir="${admin.dir}"/>
3004 <jar destfile="${build.home}/phind.jar">
3005 <fileset dir="${build.home}">
3006 <include name="org/greenstone/applet/phind/**"/>
3007 </fileset>
3008 <manifest>
3009 <attribute name="Built-By" value="${user.name}" />
3010 </manifest>
3011 </jar>
3012 <mkdir dir="${web.applet}"/>
3013 <copy file="${build.home}/phind.jar" todir="${web.applet}"/>
3014 <!-- phind also needs xercesImpl.jar and xml-apis.jar to be in web/applet -->
3015 <if>
3016 <bool><istrue value="${tomcat.islocal}"/></bool>
3017 <if><bool><available file="${catalina.home}/lib/xercesImpl.jar"/></bool><!-- moved for solr -->
3018 <copy file="${catalina.home}/lib/xercesImpl.jar" todir="${web.applet}"/>
3019 <copy file="${catalina.home}/lib/xml-apis.jar" todir="${web.applet}"/>
3020
3021 <else><!-- get from default GS3 web lib location-->
3022 <copy file="${web.lib}/xercesImpl.jar" todir="${web.applet}"/>
3023 <copy file="${web.lib}/xml-apis.jar" todir="${web.applet}"/>
3024 </else>
3025 </if>
3026 </if>
3027
3028
3029 <!-- skip anttasks for now
3030 <jar destfile="${build.home}/anttasks.jar">
3031 <fileset dir="${build.home}">
3032 <include name="org/greenstone/anttasks/**"/>
3033 </fileset>
3034 <manifest>
3035 <attribute name="Built-By" value="${user.name}" />
3036 </manifest>
3037 </jar>
3038 <copy file="${build.home}/anttasks.jar" todir="${basedir}/lib/java"/>-->
3039 <jar destfile="${build.home}/gsdl3test.jar">
3040 <fileset dir="${build.home}">
3041 <include name="org/greenstone/gsdl3/**/*Test.class"/>
3042 <include name="org/greenstone/testing/**"/>
3043 </fileset>
3044 <manifest>
3045 <attribute name="Built-By" value="${user.name}" />
3046 </manifest>
3047 </jar>
3048 <jar destfile="${build.home}/server.jar">
3049 <fileset dir="${build.home}">
3050 <include name="org/greenstone/server/**"/>
3051 <include name="org/greenstone/util/**"/>
3052 </fileset>
3053 <fileset file="${basedir}/resources/java/server.properties"/>
3054 <manifest>
3055 <attribute name="Built-By" value="${user.name}"/>
3056 </manifest>
3057 </jar>
3058 <copy file="${build.home}/server.jar" todir="${basedir}"/>
3059 </target>
3060
3061 <!-- === Eclipse targets == -->
3062 <target name="setup-for-eclipse">
3063
3064 <filter token="gsdlhome" value="${gs2build.home}"/>
3065 <filter token="gsdl3srchome" value="${basedir}"/>
3066 <filter token="gsdl3home" value="${basedir}/web"/>
3067
3068 <if>
3069 <bool><not><available file="${basedir}/TransformingLibrary.launch"/></not></bool>
3070 <copy file="${basedir}/TransformingLibrary.launch.in" tofile="${basedir}/TransformingLibrary.launch" filtering="true" overwrite="true"/>
3071 </if>
3072<!--
3073 <if>
3074 <bool><not><available file="${basedir}/LibraryCommandline.launch"/></not></bool>
3075 <copy file="${basedir}/LibraryCommandline.launch.in" tofile="${basedir}/LibraryCommandline.launch" filtering="true" overwrite="true"/>
3076 </if>
3077-->
3078 </target>
3079
3080 <!-- ================== Packages targets ================================ -->
3081 <!-- these targets refer to the greenstone source packages - these need
3082 updating less often, so are in separate targets to the core -->
3083 <target name="prepare-packages" depends="init"/>
3084
3085 <target name="update-packages" depends="init,svnupdate-packages,configure-packages,clean-packages,compile-packages"
3086 description="Update only the source packages"/>
3087
3088 <target name="svnupdate-packages" unless="nosvn.mode">
3089 <exec executable="svn">
3090 <arg value="update"/>
3091 <arg value="${src.packages.home}"/>
3092 <arg value="-r"/><arg value="${branch.revision}"/>
3093 </exec>
3094 </target>
3095
3096
3097 <target name="configure-packages" depends="init,configure-javagdbm"
3098 description="Configure only the packages."/>
3099
3100 <target name="configure-javagdbm" if="with.jni">
3101 <echo>
3102 Configuring JavaGDBM
3103 </echo>
3104
3105 <exec executable="${javagdbm.home}/configure" os="${os.unix}" dir="${javagdbm.home}" failonerror="true">
3106 <arg value="--prefix=${basedir}"/>
3107 <arg value="--libdir=${lib.jni}"/>
3108 <arg value="--with-gdbm=${gdbm.home}"/>
3109 <arg line="${cross.configure.args}"/>
3110 </exec>
3111 </target>
3112
3113 <target name="clean-packages" depends="init,clean-javagdbm" description="Clean only the packages"/>
3114
3115 <target name="clean-javagdbm" depends="init">
3116 <if><bool><available file="${javagdbm.home}/Makefile"/></bool>
3117 <exec executable="make" os="${os.unix}"
3118 dir="${javagdbm.home}" failonerror="true">
3119 <arg value="clean"/>
3120 </exec>
3121 </if>
3122 </target>
3123
3124 <target name="distclean-packages" depends="init,distclean-javagdbm" description="Distclean only the packages"/>
3125
3126 <target name="distclean-javagdbm" depends="init">
3127 <if><bool><available file="${javagdbm.home}/Makefile"/></bool>
3128 <exec executable="make" os="${os.unix}"
3129 dir="${javagdbm.home}" failonerror="true">
3130 <arg value="distclean"/>
3131 </exec>
3132 </if>
3133 </target>
3134
3135 <target name="compile-packages" description="Compile only the source packages">
3136 <!-- javagdbm -->
3137 <antcall target="compile-javagdbm"/>
3138 <!-- Search4j -->
3139 <antcall target="compile-search4j"/>
3140 </target>
3141
3142 <target name="compile-javagdbm" description="Compile JavaGDBM" if="with.jni">
3143
3144 <!-- unix: -->
3145 <echo>compile javagdbm</echo>
3146 <exec executable="make" os="${os.unix}" dir="${javagdbm.home}" failonerror="true">
3147 <arg value="JAVACOPTIONS=-encoding UTF8"/>
3148 </exec>
3149 <exec executable="make" os="${os.unix}" dir="${javagdbm.home}" failonerror="true">
3150 <arg value="install"/>
3151 </exec>
3152
3153 <!-- windows: Calling without the "compile" argument first will run winMake.bat with
3154 "all" which will then perform both the compile AND link targets in jni/win32.mak
3155 (thereby also generating gdbmjava.dll). Then we run the same command with
3156 the "install" argument to copy the gdbmjava.dll into the correct location. -->
3157 <echo>Windows: compile javagdbm</echo>
3158 <exec executable="${javagdbm.home}/winMake.bat" osfamily="windows" dir="${javagdbm.home}" failonerror="true">
3159 <env key="GSDL3SRCHOME" path="${basedir}"/>
3160 </exec>
3161 <exec executable="${javagdbm.home}/winMake.bat" osfamily="windows" dir="${javagdbm.home}" failonerror="true">
3162 <env key="GSDL3SRCHOME" path="${basedir}"/>
3163 <arg value="install"/>
3164 </exec>
3165
3166 <!-- install the jar file -->
3167 <echo>Install the javagdbm jar file ${javagdbm.home}/javagdbm.jar ${lib.jni}</echo>
3168 <copy file="${javagdbm.home}/javagdbm.jar" todir="${lib.jni}"/>
3169 </target>
3170
3171 <target name="compile-search4j">
3172
3173 <!-- windows -->
3174 <if><bool><istrue value="${current.os.iswindows}"/></bool>
3175 <exec executable="nmake" dir="${src.packages.home}/search4j" failonerror="true">
3176 <arg value="/f"/>
3177 <arg value="win32.mak"/>
3178 <arg value='BINDIR="${basedir}\bin"'/>
3179 </exec>
3180 <exec executable="nmake" dir="${src.packages.home}/search4j" failonerror="true">
3181 <arg value="/f"/>
3182 <arg value="win32.mak"/>
3183 <arg value="install"/>
3184 <arg value='BINDIR="${basedir}\bin"'/>
3185 </exec>
3186
3187 <!-- unix -->
3188 <else><if><bool><istrue value="${current.os.isunix}"/></bool>
3189 <exec executable="${src.packages.home}/search4j/configure" dir="${src.packages.home}/search4j" failonerror="true">
3190 <arg value="--bindir=${basedir}/bin"/>
3191 <arg value="${static.arg}"/>
3192 <arg line="${cross.configure.args}"/>
3193 </exec>
3194 <exec executable="make" dir="${src.packages.home}/search4j" failonerror="true"/>
3195 <exec executable="make" dir="${src.packages.home}/search4j" failonerror="true">
3196 <arg value="install"/>
3197 </exec>
3198
3199 <!-- else warn -->
3200 <else>
3201 <fail>this target does not support the current os</fail>
3202
3203 </else></if></else></if>
3204
3205 </target>
3206
3207 <target name="install-auxiliary-jar-files" depends="init">
3208
3209 <if>
3210 <bool><available file="${mg.home}/mg.jar"/></bool>
3211 <copy file="${mg.home}/mg.jar" todir="${lib.jni}"/>
3212 </if>
3213
3214 <if>
3215 <bool><available file="${mgpp.home}/mgpp.jar"/></bool>
3216 <copy file="${mgpp.home}/mgpp.jar" todir="${lib.jni}"/>
3217 </if>
3218
3219 <copy file="${lucene.home}/LuceneWrapper4.jar" todir="${web.lib}"/>
3220 </target>
3221
3222 <target name="install-jni-files" depends="init" if="with.jni">
3223 <antcall target="install-jni-files-linux"/>
3224 <antcall target="install-jni-files-windows"/>
3225 <antcall target="install-jni-files-macos"/>
3226 </target>
3227
3228 <target name="install-jni-files-linux" depends="init" if="current.os.isunixnotmac">
3229
3230 <if>
3231
3232 <bool><equals arg1="${os.bin.dir}" arg2="windows"/></bool>
3233 <!-- cross compiling to windows -->
3234 <copy file="${mg.home}/jni/mgretrievejni.dll" todir="${lib.jni}"/>
3235 <copy file="${mg.home}/jni/mgsearchjni.dll" todir="${lib.jni}"/>
3236 <copy file="${mg.home}/jni/mgpassjni.dll" todir="${lib.jni}"/>
3237 <copy file="${mgpp.home}/jni/mgppretrievejni.dll" todir="${lib.jni}"/>
3238 <copy file="${mgpp.home}/jni/mgppsearchjni.dll" todir="${lib.jni}"/>
3239 <copy file="${mgpp.home}/jni/mgpppassjni.dll" todir="${lib.jni}"/>
3240
3241 <else>
3242 <!-- otherwise do the usual Unix copies -->
3243 <copy file="${mg.home}/jni/libmgretrievejni.so" todir="${lib.jni}"/>
3244 <copy file="${mg.home}/jni/libmgsearchjni.so" todir="${lib.jni}"/>
3245 <copy file="${mg.home}/jni/libmgpassjni.so" todir="${lib.jni}"/>
3246 <copy file="${mgpp.home}/jni/libmgppretrievejni.so" todir="${lib.jni}"/>
3247 <copy file="${mgpp.home}/jni/libmgppsearchjni.so" todir="${lib.jni}"/>
3248 <copy file="${mgpp.home}/jni/libmgpppassjni.so" todir="${lib.jni}"/>
3249 </else>
3250 </if>
3251
3252
3253 </target>
3254 <target name="install-jni-files-windows" depends="init" if="current.os.iswindows">
3255 <copy file="${mg.home}/jni/mgretrievejni.dll" todir="${lib.jni}"/>
3256 <copy file="${mg.home}/jni/mgsearchjni.dll" todir="${lib.jni}"/>
3257 <copy file="${mg.home}/jni/mgpassjni.dll" todir="${lib.jni}"/>
3258 <copy file="${mgpp.home}/jni/mgppretrievejni.dll" todir="${lib.jni}"/>
3259 <copy file="${mgpp.home}/jni/mgppsearchjni.dll" todir="${lib.jni}"/>
3260 <copy file="${mgpp.home}/jni/mgpppassjni.dll" todir="${lib.jni}"/>
3261 </target>
3262 <target name="install-jni-files-macos" depends="init" if="current.os.ismac">
3263 <copy file="${mg.home}/jni/libmgretrievejni.jnilib" todir="${lib.jni}"/>
3264 <copy file="${mg.home}/jni/libmgsearchjni.jnilib" todir="${lib.jni}"/>
3265 <copy file="${mg.home}/jni/libmgpassjni.jnilib" todir="${lib.jni}"/>
3266 <copy file="${mgpp.home}/jni/libmgppretrievejni.jnilib" todir="${lib.jni}"/>
3267 <copy file="${mgpp.home}/jni/libmgppsearchjni.jnilib" todir="${lib.jni}"/>
3268 <copy file="${mgpp.home}/jni/libmgpppassjni.jnilib" todir="${lib.jni}"/>
3269 </target>
3270
3271 <!-- ========common-src targets =================================-->
3272 <!-- these are used to get common-src (for indexers, gdbm, sqlite etc) when
3273 collection building is not enabled -->
3274
3275 <target name="update-common-src" depends="init" if="collection.building.disabled">
3276 </target>
3277
3278 <target name="svnupdate-common-src" depends="init" if="collection.building.disabled" unless="nosvn.mode">
3279 <exec executable="svn">
3280 <arg value="update"/>
3281 <arg value="${common.src.home}"/>
3282 <arg value="-r"/><arg value="${branch.revision}"/>
3283 </exec>
3284 </target>
3285
3286 <target name="prepare-common-src" depends="init" if="collection.building.disabled" unless="common.src.present">
3287 <antcall target="checkout-common-src"/>
3288 <antcall target="unzip-windows-packages"/>
3289 </target>
3290
3291 <target name="checkout-common-src" depends="init" if="collection.building.disabled" unless="nosvn.mode">
3292 <echo>checking out common-src</echo>
3293 <exec executable="svn">
3294 <arg value="checkout"/>
3295 <arg value="${svn.root}/main/${branch.path}/greenstone2/common-src"/>
3296 <arg value="common-src"/>
3297 <arg value="-r"/><arg value="${branch.revision}"/>
3298 </exec>
3299 </target>
3300
3301 <target name="configure-common-src" depends="init">
3302<!--
3303 <echo>cross configure args: ${cross.configure.args}</echo>
3304-->
3305 <exec executable="${common.src.home}/configure" os="${os.unix}"
3306 dir="${common.src.home}" failonerror="true">
3307 <arg value="--prefix=${gs2build.home}"/> <!-- what value to use?? -->
3308 <arg value="--bindir=${gs2build.home}/bin/${os.bin.dir}"/> <!-- what value to use?? -->
3309 <arg line="${gs2.opt.args}"/>
3310 <arg line="${static.arg}"/>
3311 <arg line="${cross.configure.args}"/>
3312 <arg line="${allargs}"/>
3313 </exec>
3314 </target>
3315
3316 <target name="clean-common-src" depends="init">
3317 <!-- unix: -->
3318 <if><bool><available file="${common.src.home}/Makefile"/></bool>
3319 <exec executable="make" os="${os.unix}" dir="${common.src.home}" failonerror="true">
3320 <arg value="clean"/>
3321 </exec>
3322 </if>
3323 <!-- windows: -->
3324 <exec executable="nmake" dir="${common.src.home}" osfamily="windows" failonerror="true">
3325 <arg value="/f"/>
3326 <arg value="win32.mak"/>
3327 <arg value="clean"/>
3328 <arg value="GSDLHOME=${gs2build.home}"/>
3329 </exec>
3330 </target>
3331 <target name="distclean-common-src" depends="init">
3332 <!-- unix: -->
3333 <if><bool><available file="${common.src.home}/Makefile"/></bool>
3334 <exec executable="make" os="${os.unix}" dir="${common.src.home}" failonerror="true">
3335 <arg value="distclean"/>
3336 </exec>
3337 </if>
3338 <!-- windows: distclean = clean + remove configure products (remove makefiles). But on Windows there is no removing makefiles, so we just call clean -->
3339 <exec executable="nmake" dir="${common.src.home}" osfamily="windows" failonerror="true">
3340 <arg value="/f"/>
3341 <arg value="win32.mak"/>
3342 <arg value="clean"/>
3343 <arg value="GSDLHOME=${gs2build.home}"/>
3344 </exec>
3345 </target>
3346 <target name="compile-common-src" depends="init">
3347 <!-- unix: -->
3348 <exec executable="make" os="${os.unix}" dir="${common.src.home}" failonerror="true">
3349 <arg value="${gs2.compile.target}"/>
3350 </exec>
3351 <!-- windows: -->
3352 <exec executable="nmake" dir="${common.src.home}" osfamily="windows" failonerror="true">
3353 <arg value="/f"/>
3354 <arg value="win32.mak"/>
3355 <arg value="GSDLHOME=${gs2build.home}"/>
3356 <arg value="ENABLE_JNI=${gs2.windows.enablejni}"/>
3357 <arg value="ENABLE_MG=${gs2.windows.enablemg}"/>
3358 <arg value="ENABLE_MGPP=${gs2.windows.enablemgpp}"/>
3359 <arg value="USE_GDBM=${gs2.windows.usegdbm}"/>
3360 <arg value="USE_SQLITE=${gs2.windows.usesqlite}"/>
3361 </exec>
3362 </target>
3363
3364 <!-- ======= collection-building targets ===========================-->
3365
3366 <target name="update-collection-building" if="collection.building.enabled"
3367 depends="init,svnupdate-collection-building,gs2build-edit-setup-bat,configure-common-src,clean-common-src,compile-common-src,clean-collection-building,configure-collection-building,compile-collection-building"
3368 description="Update (SVN update, configure, compile etc) only the collection building components"/>
3369
3370 <target name="svnupdate-collection-building" if="collection.building.enabled" depends="init,svnupdate-gs2build,svnupdate-cgi,svnupdate-gli" unless="nosvn.mode"
3371 description="SVN update the collection building components">
3372 </target>
3373
3374 <target name="prepare-collection-building" depends="init,prepare-gs2build,svnupdate-cgi,prepare-gli" if="collection.building.enabled">
3375 </target>
3376
3377 <target name="configure-collection-building" depends="init,configure-build-src" if="collection.building.enabled"
3378 description="Configure the collection building components">
3379 </target>
3380
3381 <target name="clean-collection-building" depends="init,clean-gli,clean-build-src"
3382 description="Clean only the collection building components"
3383 if="collection.building.enabled"/>
3384
3385 <target name="distclean-collection-building" depends="init,clean-build-src,distclean-build-src"
3386 description="Distclean only the collection building components"
3387 if="collection.building.enabled"/>
3388
3389 <target name="compile-collection-building" depends="init,compile-build-src,compile-gli" if="collection.building.enabled"
3390 description="Compile only the collection building components">
3391 <!-- make install for common-src -->
3392 <!-- unix: -->
3393 <exec executable="make" os="${os.unix}" dir="${common.src.home}" failonerror="true">
3394 <arg value="${gs2.install.target}"/>
3395 </exec>
3396
3397 <!-- windows: -->
3398 <exec executable="nmake" dir="${common.src.home}" osfamily="windows" failonerror="true">
3399 <arg value="/f"/>
3400 <arg value="win32.mak"/>
3401 <arg value="install"/>
3402 <arg value="GSDLHOME=${gs2build.home}"/>
3403 <arg value="ENABLE_JNI=${gs2.windows.enablejni}"/>
3404 <arg value="ENABLE_MG=${gs2.windows.enablemg}"/>
3405 <arg value="ENABLE_MGPP=${gs2.windows.enablemgpp}"/>
3406 <arg value="USE_GDBM=${gs2.windows.usegdbm}"/>
3407 <arg value="USE_SQLITE=${gs2.windows.usesqlite}"/>
3408 <!--
3409 <arg value="ENABLE_JNI=${gs2.windows.enablejni}"/>
3410 <arg value="USE_SQLITE=0"/>--> <!-- why is this not on by default? -->
3411 </exec>
3412
3413 <!-- install gs2build indexers for windows -->
3414 <if>
3415 <bool><istrue value="${current.os.iswindows}"/></bool>
3416 <copy todir="${gs2build.home}/bin/windows">
3417 <fileset dir="${gs2build.home}/common-src/indexers/bin">
3418 <include name="*.*"/>
3419 </fileset>
3420 </copy>
3421 </if>
3422
3423 <!-- LuceneWrapper jar file not installed by default -->
3424 <mkdir dir="${gs2build.home}/bin/java"/>
3425 <copy file="${lucene.home}/LuceneWrapper4.jar" todir="${gs2build.home}/bin/java"/>
3426
3427 </target>
3428
3429 <!-- ============== gli targets ================================= -->
3430
3431 <!-- gliserver.pl, gsdlCGI.pm, metadata-server.pl and checksum.pl are updated alongside
3432 this in target svnupdate-collection-building -->
3433 <target name="svnupdate-gli" if="collection.building.enabled" depends="init" unless="nosvn.mode">
3434
3435 <exec executable="svn">
3436 <arg value="update"/>
3437 <arg value="${gli.home}"/>
3438 <arg value="-r"/><arg value="${branch.revision}"/>
3439 </exec>
3440
3441 </target>
3442
3443 <!-- gliserver.pl, gsdlCGI.pm, metadata-server.pl and checksum.pl are updated
3444 alongside this prepare-gli target in target prepare-collection-building -->
3445 <target name="prepare-gli" depends="init" if="collection.building.enabled" unless="gli.present">
3446 <!-- checkout -->
3447 <if><bool><and><not><istrue value="${nosvn.mode}"/></not><isset property="with.gli.and.gems"/></and></bool>
3448
3449 <exec executable="svn">
3450 <arg value="checkout"/>
3451 <arg value="${svn.root}/main/${branch.path}/gli"/>
3452 <arg value="-r"/><arg value="${branch.revision}"/>
3453 </exec>
3454
3455 </if>
3456 </target>
3457
3458 <!-- svn checkout gliserver.pl, gsdlCGI.pm for gli applet, as well as gsdlCGI.pm-dependent metadata-server.pl
3459 (checksum.pl is used by GS2 for depositdspace.dm and may eventually be used by GS3 too) -->
3460 <target name="svnupdate-cgi">
3461
3462 <exec executable="svn" dir="web/WEB-INF/cgi">
3463 <arg value="export"/>
3464 <arg value="-r"/><arg value="${branch.revision}"/>
3465 <arg value="${svn.root}/main/${branch.path}/greenstone2/common-src/cgi-bin/gliserver.pl"/>
3466 </exec>
3467 <exec executable="svn" dir="web/WEB-INF/cgi">
3468 <arg value="export"/>
3469 <arg value="-r"/><arg value="${branch.revision}"/>
3470 <arg value="${svn.root}/main/${branch.path}/greenstone2/common-src/cgi-bin/gsdlCGI.pm"/>
3471 </exec>
3472 <exec executable="svn" dir="web/WEB-INF/cgi">
3473 <arg value="export"/>
3474 <arg value="-r"/><arg value="${branch.revision}"/>
3475 <arg value="${svn.root}/main/${branch.path}/greenstone2/common-src/cgi-bin/metadata-server.pl"/>
3476 </exec>
3477 <exec executable="svn" dir="web/WEB-INF/cgi">
3478 <arg value="export"/>
3479 <arg value="-r"/><arg value="${branch.revision}"/>
3480 <arg value="${svn.root}/main/${branch.path}/greenstone2/common-src/cgi-bin/checksum.pl"/>
3481 </exec>
3482 </target>
3483
3484
3485 <target name="clean-gli" depends="init" if="collection.building.enabled">
3486 <!-- gli -->
3487 <property name="gli.home" value="${basedir}/gli"/>
3488 <!-- linux -->
3489 <exec executable="clean.sh" os="${os.unix}" dir="${gli.home}"
3490 resolveExecutable="true" failonerror="true"/>
3491 <!-- windows -->
3492 <exec executable="clean.bat" osfamily="windows" dir="${gli.home}"
3493 resolveExecutable="true" failonerror="true"/>
3494 </target>
3495
3496 <target name="compile-gli" depends="init" if="collection.building.enabled">
3497 <if><bool><isset property="with.gli.and.gems"/></bool>
3498 <!-- gli -->
3499 <property name="gli.home" value="${basedir}/gli"/>
3500
3501 <!-- linux -->
3502 <exec executable="makegli.sh" os="${os.unix}" dir="${gli.home}" resolveExecutable="true" failonerror="true"/>
3503 <!--remote gli-->
3504 <exec executable="makejar.sh" os="${os.unix}" dir="${gli.home}"
3505 resolveExecutable="true" failonerror="true"/>
3506 <!-- windows -->
3507 <exec executable="makegli.bat" osfamily="windows" dir="${gli.home}" resolveExecutable="true" failonerror="true"/>
3508 <!--remote gli-->
3509 <exec executable="makejar.bat" osfamily="windows" dir="${gli.home}"
3510 resolveExecutable="true" failonerror="true"/>
3511 <copy file="${gli.home}/GLIServer.jar" todir="${gs2build.home}/bin/java" />
3512 </if>
3513 </target>
3514
3515 <target name="gli" description="Run the Greenstone Librarian Interface" depends="init" if="collection.building.enabled">
3516 <exec executable="${basedir}/gli/gli.sh" os="${os.linux},${os.solaris}" dir="${basedir}/gli" spawn="true">
3517 <env key="gsdl3path" path="${basedir}"/>
3518 <env key="gsdlpath" path="${gs2build.home}"/>
3519 </exec>
3520 <exec executable="${basedir}/gli/gli.sh" os="${os.mac}" dir="${basedir}/gli" spawn="true">
3521 <env key="gsdl3path" path="${basedir}"/>
3522 <env key="gsdlpath" path="${gs2build.home}"/>
3523 <env key="DYLD_LIBRARY_PATH" path="${env.DYLD_LIBRARY_PATH}:${gdbm.home}/lib"/>
3524 </exec>
3525 <exec executable="${basedir}/gli/gli.bat" osfamily="windows" dir="${basedir}/gli" spawn="true">
3526 <env key="GSDL3PATH" path="${basedir}"/>
3527 <env key="GSDLPATH" path="${gs2build.home}"/>
3528 </exec>
3529 <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.
3530 </echo>
3531 </target>
3532
3533 <!-- ================ gs2build targets =========================== -->
3534
3535 <target name="svnupdate-gs2build" if="collection.building.enabled" depends="init" unless="nosvn.mode">
3536 <echo>svn updating gs2build</echo>
3537 <exec executable="svn">
3538 <arg value="update"/>
3539 <arg value="${gs2build.home}"/>
3540 <arg value="-r"/><arg value="${branch.revision}"/>
3541 </exec>
3542 </target>
3543
3544 <target name="prepare-gs2build" depends="init" if="collection.building.enabled" unless="gs2build.present">
3545 <antcall target="checkout-gs2build"/>
3546 <antcall target="prepare-pdfbox"/>
3547 <antcall target="prepare-imagemagick"/> <!-- has to be done before calling prepare-gnome-lib -->
3548 <antcall target="prepare-gnome-lib"/>
3549 <antcall target="unzip-windows-packages"/>
3550 <antcall target="checkout-winbin"/>
3551 <antcall target="get-windows-binaries"/>
3552 <antcall target="delete-winbin"/>
3553 </target>
3554
3555 <target name="checkout-gs2build" depends="init" if="collection.building.enabled" unless="nosvn.mode">
3556 <echo>checking out gs2build</echo>
3557 <exec executable="svn">
3558 <arg value="checkout"/>
3559 <arg value="${svn.root}/main/${branch.path}/gs2build"/>
3560 <arg value="-r"/><arg value="${branch.revision}"/>
3561 </exec>
3562 </target>
3563
3564 <!-- Gets the PDFBox extension into gs2build/ext if checkout.pdfbox.ext is set to true in build.properties
3565 (which it is by default) -->
3566 <target name="prepare-pdfbox" depends="init" if="collection.building.enabled">
3567 <if>
3568 <bool>
3569 <istrue value="${checkout.pdfbox.ext}"/>
3570 </bool>
3571
3572 <property name="pdfbox.ext.dir" value="${gs2build.home}/ext/pdf-box"/>
3573 <condition property="pdfbox.ext.present">
3574 <available file="${pdfbox.ext.dir}" type="dir" />
3575 </condition>
3576
3577 <!-- 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-->
3578 <if>
3579 <bool>
3580 <not><istrue value="${pdfbox.ext.present}"/></not>
3581 </bool>
3582
3583 <if>
3584 <bool>
3585 <not><istrue value="${gs2build.home}/ext/pdf-box-java.tar.gz"/></not>
3586 </bool>
3587
3588 <echo>Checking out the PDFBox extension into the GSDLHOME extension area</echo>
3589 <exec executable="svn">
3590 <arg value="export"/>
3591 <arg value="${svn.root}/gs2-extensions/pdf-box/trunk/pdf-box-java.tar.gz"/>
3592 <arg value="${gs2build.home}/ext/pdf-box-java.tar.gz"/>
3593 </exec>
3594 </if>
3595
3596 <echo>Extacting the PDFBox extension into the GSDLHOME extension area</echo>
3597 <untar compression="gzip"
3598 src="${gs2build.home}/ext/pdf-box-java.tar.gz"
3599 dest="${gs2build.home}/ext"/>
3600
3601 <delete file="${gs2build.home}/ext/pdf-box-java.tar.gz"/>
3602
3603 <else>
3604 <echo>The PDFBox extension already exists at ${pdfbox.ext.dir}</echo>
3605 </else>
3606 </if>
3607
3608 <else>
3609 <echo>**** Not preparing the PDFBox extension:</echo>
3610 <echo>The property checkout.pdfbox.ext in build.properties was not set or was set to false</echo>
3611 </else>
3612 </if>
3613 </target>
3614
3615 <target name="prepare-imagemagick" depends="init" if="collection.building.enabled">
3616 <if>
3617 <bool>
3618 <istrue value="${checkout.imagemagick.ext}"/>
3619 </bool>
3620
3621 <antcall target="checkout-imagemagick"/>
3622 <!--Compilation of imagemagick now happens during ant install, still before configuring the src code, as before -->
3623
3624 <else>
3625 <echo>**** Not preparing imagemagick:</echo>
3626 <echo>property checkout.imagemagick.ext in build.properties was not set or was set to false</echo>
3627 </else>
3628 </if>
3629 </target>
3630
3631 <target name="checkout-imagemagick" depends="init" if="collection.building.enabled" unless="nosvn.mode">
3632
3633 <property name="imagemagick.src.dir" value="${gs2build.home}/ext/imagemagick"/>
3634 <condition property="imagemagick.src.present">
3635 <available file="${imagemagick.src.dir}" type="dir" />
3636 </condition>
3637
3638 <if>
3639 <bool>
3640 <not><istrue value="${imagemagick.src.present}"/></not>
3641 </bool>
3642
3643 <echo>checking out imagemagick source into the extension area</echo>
3644
3645 <exec executable="svn">
3646 <arg value="checkout"/>
3647 <arg value="${svn.root}/gs2-extensions/imagemagick/trunk/src"/>
3648 <arg value="${imagemagick.src.dir}"/>
3649 </exec>
3650
3651 <else>
3652 <echo>imagemagick source code already exists at ${imagemagick.src.dir}</echo>
3653 </else>
3654 </if>
3655 </target>
3656
3657 <!-- 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. -->
3658 <target name="compile-imagemagick" if="checkout.imagemagick.ext">
3659
3660 <property name="imagemagick.src.dir" value="${gs2build.home}/ext/imagemagick"/>
3661 <property name="imagemagick.compiled.dir" value="${gs2build.home}/ext/imagemagick/${os.bin.dir}"/>
3662
3663 <condition property="imagemagick.src.present.firstcheck">
3664 <available file="${imagemagick.src.dir}" type="dir" />
3665 </condition>
3666 <condition property="imagemagick.compiled.present">
3667 <available file="${imagemagick.compiled.dir}" type="dir"/>
3668 </condition>
3669 <!--<condition property="imagemagick.bin.present">
3670 <available file="${basedir}/wherever/the/imgmagick/binary/is/to/be/found" type="dir" />
3671 </condition>-->
3672
3673 <!-- imagemagick will only be checked out if the user set the checkout.imagemagick.ext in build.properties -->
3674 <if>
3675 <bool>
3676 <isfalse value="${imagemagick.src.present.firstcheck}"/>
3677 </bool>
3678 <antcall target="checkout-imagemagick"/>
3679 </if>
3680
3681 <!-- keep track of whether the imagemagick src is now indeed present. Need to know this for a subsequent test -->
3682 <condition property="imagemagick.src.present">
3683 <available file="${imagemagick.src.dir}" type="dir" />
3684 </condition>
3685
3686 <if>
3687 <bool>
3688 <and>
3689 <istrue value="${imagemagick.src.present}"/> <!-- imagemagick src code is present -->
3690 <isfalse value="${imagemagick.compiled.present}"/> <!-- imagemagick src not compiled yet, so no imagemagick/os subfolder yet -->
3691 </and>
3692 </bool>
3693 <!-- then compile it. Only necessary for mac/linux, since windows has a stable working binary of imagemagick -->
3694 <exec executable="/bin/bash" dir="${imagemagick.src.dir}" failonerror="true">
3695 <arg value="CASCADE-MAKE.sh"/>
3696 </exec>
3697 </if>
3698 </target>
3699
3700
3701 <!-- Compile up gnome-lib src folder if: checkout.gnomelib.ext is turned on, and if not using the binary
3702 version (gnome-lib-minimal), and if the gnome-lib src folder is not already compiled up. -->
3703 <target name="compile-gnome-lib" if="checkout.gnomelib.ext">
3704
3705 <!-- http://stackoverflow.com/questions/3290307/sourcing-a-shell-profile-in-an-ant-build-file
3706 TODO: CASCADE-MAKE already sources devel.bash, but we still want to source it more globally,
3707 so that the rest of the GS3 compilation process also has access to those env variables -->
3708
3709 <property name="gnome.lib.src.dir" value="${basedir}/gs2build/ext/gnome-lib"/>
3710 <property name="gnome.lib.compiled.dir" value="${basedir}/gs2build/ext/gnome-lib/${os.bin.dir}"/>
3711
3712 <condition property="gnome.src.lib.present.firstcheck" value="true" else="false">
3713 <available file="${gnome.lib.src.dir}" type="dir" />
3714 </condition>
3715 <condition property="gnome.compiled.lib.present" value="true" else="false">
3716 <available file="${gnome.lib.compiled.dir}" type="dir"/>
3717 </condition>
3718 <condition property="gnome.lib.min.present" value="true" else="false">
3719 <available file="${basedir}/gs2build/ext/gnome-lib-minimal" type="dir" />
3720 </condition>
3721
3722 <!-- Make sure to checkout gnome-lib if it was not checked out at this stage
3723 since we're instructed to do so in th pre-condition to this target -->
3724 <if>
3725 <bool>
3726 <and>
3727 <isfalse value="${gnome.lib.min.present}"/>
3728 <isfalse value="${gnome.src.lib.present.firstcheck}"/>
3729 </and>
3730 </bool>
3731 <antcall target="checkout-gnome-lib"/>
3732 </if>
3733
3734 <!-- Keep track of whether we have the gnome-lib src folder now. Need to know this for a subsequent test -->
3735 <condition property="gnome.src.lib.present" value="true" else="false">
3736 <available file="${gnome.lib.src.dir}" type="dir" />
3737 </condition>
3738
3739 <!--<echo>MIN: ${gnome.lib.min.present}
3740 SRC LIB: ${gnome.src.lib.present}
3741 COMPILED: ${gnome.compiled.lib.present}</echo>-->
3742
3743 <if>
3744 <bool>
3745 <and>
3746 <isfalse value="${gnome.lib.min.present}"/> <!-- no gnome-lib-minimal binary present -->
3747 <istrue value="${gnome.src.lib.present}"/> <!-- gnome-lib folder for compilation is present-->
3748 <isfalse value="${gnome.compiled.lib.present}"/> <!-- gnome-lib not yet compiled, so no gnome-lib/os subfolder yet -->
3749 </and>
3750 </bool>
3751
3752 <!-- then compile it. Only necessary for mac/linux, since windows doesn't need gnome lib -->
3753 <exec executable="/bin/bash" dir="${gnome.lib.src.dir}" failonerror="true">
3754 <arg value="CASCADE-MAKE.sh"/>
3755 </exec>
3756 </if>
3757 </target>
3758
3759
3760 <target name="prepare-gnome-lib" depends="init" if="collection.building.enabled" unless="gnome-lib.present">
3761 <if>
3762 <bool>
3763 <istrue value="${checkout.gnomelib.ext}"/>
3764 </bool>
3765
3766 <antcall target="checkout-gnome-lib"/>
3767 <!--Compilation of gnome-lib happens during ant install, just before configuring (common-src and) build-src-->
3768
3769 <else>
3770 <echo>**** Not preparing gnome-lib:</echo>
3771 <echo>property checkout.gnomelib.ext in build.properties was not set or was set to false</echo>
3772 </else>
3773 </if>
3774 </target>
3775
3776
3777 <target name="checkout-gnome-lib" depends="init" if="collection.building.enabled" unless="nosvn.mode">
3778
3779 <property name="gnomelib.src.dir" value="${basedir}/gs2build/ext/gnome-lib"/>
3780 <condition property="gnome.src.present">
3781 <available file="${gnomelib.src.dir}" type="dir" />
3782 </condition>
3783
3784 <if>
3785 <bool>
3786 <not><istrue value="${gnome.src.present}"/></not>
3787 </bool>
3788
3789 <echo>checking out gnome-lib extension</echo>
3790 <exec executable="svn">
3791 <arg value="checkout"/>
3792 <arg value="${svn.root}/gs2-extensions/gnome-lib/trunk/src"/>
3793 <arg value="${gs2build.home}/ext/gnome-lib"/>
3794 </exec>
3795
3796 <else>
3797 <echo>gnomelib source code already exists at ${gnomelib.src.dir}</echo>
3798 </else>
3799 </if>
3800
3801 </target>
3802
3803 <target name="checkout-winbin" depends="init" if="current.os.iswindows"
3804 unless="nosvn.mode">
3805
3806 <exec executable="svn">
3807 <arg value="checkout"/>
3808 <arg value="${svn.root}/main/${branch.path}/binaries/windows"/>
3809 <arg value="-r"/><arg value="${branch.revision}"/>
3810 <arg value="winbin"/>
3811 </exec>
3812
3813 </target>
3814
3815 <target name="update-winbin" depends="init" if="current.os.iswindows" unless="nosvn.mode">
3816 <exec executable="svn">
3817 <arg value="update"/>
3818 <arg value="winbin"/>
3819 <arg value="-r"/><arg value="${branch.revision}"/>
3820 </exec>
3821
3822 </target>
3823
3824 <target name="get-windows-binaries" depends="init" if="collection.building.enabled.windows">
3825 <move todir="${gs2build.home}/bin/windows" failonerror="false">
3826 <fileset dir="${basedir}/winbin/bin"/>
3827 </move>
3828 </target>
3829
3830 <target name="delete-winbin" depends="init" if="collection.building.enabled.windows">
3831 <delete dir="${basedir}/winbin"/>
3832 </target>
3833
3834 <target name="unzip-windows-packages" depends="init" if="current.os.iswindows">
3835 <unzip src="${common.src.home}/packages/windows/crypt/crypt.zip"
3836 dest="${common.src.home}/packages/windows/crypt"/>
3837 <untar compression="gzip"
3838 src="${common.src.home}/packages/sqlite/${sqlite.targz.version}"
3839 dest="${common.src.home}/packages/sqlite"/>
3840 <unzip src="${common.src.home}/indexers/packages/windows/iconv/iconv.zip"
3841 dest="${common.src.home}/indexers/packages/windows/iconv"/>
3842 </target>
3843
3844 <target name="gs2build-edit-setup-bat" if="collection.building.enabled.windows">
3845 <!-- we want a windows path in the setup.bat file -->
3846 <pathconvert targetos="windows" property="gs2build.home.windows">
3847 <path path="${gs2build.home}"/>
3848 </pathconvert>
3849 <move file="${gs2build.home}/setup.bat" tofile="${gs2build.home}/setup-tmp.bat">
3850 <filterset>
3851 <filter token="gsdlhome" value="${gs2build.home.windows}"/>
3852 </filterset>
3853 </move>
3854 <move file="${gs2build.home}/setup-tmp.bat" tofile="${gs2build.home}/setup.bat" />
3855 </target>
3856
3857
3858 <target name="clean-build-src" depends="init" if="collection.building.enabled">
3859 <!-- unix: -->
3860 <if><bool><available file="${build.src.home}/Makefile"/></bool>
3861 <exec executable="make" os="${os.unix}" dir="${build.src.home}" failonerror="true">
3862 <arg value="clean"/>
3863 </exec>
3864 </if>
3865 <!-- windows: -->
3866 <exec executable="nmake" dir="${build.src.home}" osfamily="windows" failonerror="true">
3867 <arg value="/f"/>
3868 <arg value="win32.mak"/>
3869 <arg value="clean"/>
3870 <arg value="GSDLHOME=${gs2build.home}"/>
3871 </exec>
3872 </target>
3873
3874
3875 <target name="distclean-build-src" depends="init,clean-build-src" if="collection.building.enabled">
3876 <!-- unix: -->
3877 <if><bool><available file="${build.src.home}/Makefile"/></bool>
3878 <exec executable="make" os="${os.unix}" dir="${build.src.home}" failonerror="true">
3879 <arg value="distclean"/>
3880 </exec>
3881 </if>
3882 <!-- windows: distclean = clean + remove configure products (remove makefiles). But on Windows there is no removing makefiles, so we just call clean -->
3883 <exec executable="nmake" dir="${build.src.home}" osfamily="windows" failonerror="true">
3884 <arg value="/f"/>
3885 <arg value="win32.mak"/>
3886 <arg value="clean"/>
3887 <arg value="GSDLHOME=${gs2build.home}"/>
3888 </exec>
3889 </target>
3890
3891 <target name="configure-build-src" depends="init" if="collection.building.enabled"
3892 description="Configure the build-src component">
3893 <exec executable="${build.src.home}/configure" os="${os.unix}"
3894 dir="${build.src.home}" failonerror="true">
3895 <arg value="--prefix=${gs2build.home}"/>
3896 <arg line="${gs2.opt.args} ${static.arg} ${cross.configure.args} ${allargs}"/>
3897 </exec>
3898 </target>
3899
3900 <!-- common-src is done separately and needs to be compiled first -->
3901 <target name="compile-build-src" depends="init" if="collection.building.enabled">
3902
3903 <exec executable="make" dir="${build.src.home}" os="${os.unix}" failonerror="true">
3904 <arg line="${ldlpath.arg}"/>
3905 </exec>
3906
3907 <exec executable="make" dir="${build.src.home}" os="${os.unix}" failonerror="true">
3908 <env key="GSDLOS" value="${os.bin.dir}"/>
3909 <arg value="install"/>
3910 </exec>
3911
3912 <!-- run the setup script -->
3913 <!-- <exec executable="${compile.windows.c++.setup}" osfamily="windows" failonerror="true"/>-->
3914 <!--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-->
3915 <exec executable="nmake" dir="${build.src.home}" osfamily="windows" failonerror="true">
3916 <arg value="/f"/>
3917 <arg value="win32.mak"/>
3918 <arg value="GSDLHOME=${gs2build.home}"/>
3919 </exec>
3920 <exec executable="nmake" dir="${build.src.home}" osfamily="windows" failonerror="true">
3921 <arg value="/f"/>
3922 <arg value="win32.mak"/>
3923 <arg value="install"/>
3924 <arg value="GSDLHOME=${gs2build.home}"/>
3925 </exec>
3926 </target>
3927
3928
3929 <!-- ======================== TESTING Targets ========================= -->
3930
3931 <target name="test" description="Run the (incomplete) JUnit test suite "
3932 depends="init">
3933 <mkdir dir="${basedir}/test"/>
3934 <junit printsummary="withOutAndErr"
3935 errorproperty="test.failed"
3936 failureproperty="test.failed"
3937 fork="${junit.fork}">
3938 <formatter type="plain"/>
3939 <classpath>
3940 <pathelement location="${build.home}/gsdl3test.jar"/>
3941 <path refid="compile.classpath"/>
3942 </classpath>
3943 <test name="${testcase}" if="testcase"/>
3944 <batchtest todir="${basedir}/test" unless="testcase">
3945 <fileset dir="${build.home}" includes="**/*Test.class" />
3946 </batchtest>
3947 </junit>
3948 <echo>
3949 *********************************************
3950 Test output can be found in directory 'test'
3951 *********************************************
3952 </echo>
3953 </target>
3954
3955 <!-- ======================== FLAX Targets ========================= -->
3956 <target name="prepare-flax" description="check out flax source code from another repository" if="install.flax">
3957 <echo>checking out flax ...</echo>
3958 <mkdir dir="${basedir}/src/java/org/flax"/>
3959 <mkdir dir="${basedir}/src/java/org/greenstone/gsdl3/flax"/>
3960 <mkdir dir="${basedir}/src/java/org/greenstone/gsdl3/action/flax"/>
3961 <mkdir dir="${web.home}/WEB-INF/classes/flax"/>
3962 <mkdir dir="${web.home}/interfaces/flax"/>
3963 <mkdir dir="${web.home}/sites/flax"/>
3964 <mkdir dir="${basedir}/flax-resources"/>
3965 <mkdir dir="${basedir}/flax-lib"/>
3966 <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/src/java/org/flax"/>
3967 <arg value="src/java/org/flax"/></exec>
3968 <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/src/java/org/greenstone/gsdl3/flax"/>
3969 <arg value="src/java/org/greenstone/gsdl3/flax"/></exec>
3970 <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/src/java/org/greenstone/gsdl3/action/flax"/>
3971 <arg value="src/java/org/greenstone/gsdl3/action/flax"/></exec>
3972 <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/web/WEB-INF/classes/flax"/>
3973 <arg value="${web.home}/WEB-INF/classes/flax"/></exec>
3974 <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/web/interfaces/flax"/>
3975 <arg value="${web.home}/interfaces/flax"/></exec>
3976 <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/web/sites/flax"/>
3977 <arg value="${web.home}/sites/flax"/></exec>
3978 <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/flax-resources"/>
3979 <arg value="flax-resources"/></exec>
3980 <exec executable="svn"><arg value="checkout"/><arg value="${flax.checkout.path}/lib"/>
3981 <arg value="flax-lib"/></exec>
3982 <antcall target="flax-copy-del-files" />
3983 </target>
3984
3985 <target name="flax-copy-del-files" description="copy some flax files into the appropriate greenstone3 directories and delete some unwanted greenstone stuff">
3986 <copy file="${web.home}/WEB-INF/classes/flax/web.xml" todir="${web.home}/WEB-INF" overwrite="true" />
3987 <copy todir="${web.home}/WEB-INF/lib">
3988 <fileset dir="${basedir}/flax-lib">
3989 <include name="*.jar"/>
3990 </fileset>
3991 </copy>
3992 <!--<delete dir="${web.home}/sites/gateway"/>
3993 <delete dir="${web.home}/sites/localsite"/>-->
3994 </target>
3995
3996 <target name="update-flax" description="update flax from repository">
3997 <echo>updating flax ...</echo>
3998 <exec executable="svn"><arg value="update"/>
3999 <arg value="src/java/org/flax"/></exec>
4000 <exec executable="svn"><arg value="update"/>
4001 <arg value="src/java/org/greenstone/gsdl3/action/flax"/></exec>
4002 <exec executable="svn"><arg value="update"/>
4003 <arg value="src/java/org/greenstone/gsdl3/flax"/></exec>
4004 <exec executable="svn"><arg value="update"/>
4005 <arg value="${web.home}/WEB-INF/classes/flax"/></exec>
4006 <exec executable="svn"><arg value="update"/>
4007 <arg value="${web.home}/interfaces/flax"/></exec>
4008 <exec executable="svn"><arg value="update"/>
4009 <arg value="${web.home}/web/sites/flax"/></exec>
4010 <exec executable="svn"><arg value="update"/>
4011 <arg value="flax-resources"/></exec>
4012 <exec executable="svn"><arg value="update"/>
4013 <arg value="flax-lib"/></exec>
4014 <antcall target="compile-core" />
4015 </target>
4016
4017 <!-- ========================End of FLAX Targets ========================= -->
4018
4019 <target name="compile-javadocs">
4020 <javadoc packagenames="org.greenstone.*"
4021 sourcepath="src/java"
4022 defaultexcludes="yes"
4023 destdir="docs/javadoc"
4024 author="true"
4025 version="true"
4026 use="true"
4027 windowtitle="Greenstone3 API">
4028 <doctitle><![CDATA[<h1>Greenstone3 API</h1>]]></doctitle>
4029 </javadoc>
4030 </target>
4031
4032<!-- ========== Some distribution targets ======================== -->
4033 <target name="remove-source">
4034 <if><bool><isset property="with.gli.and.gems"/></bool>
4035 <delete includeEmptyDirs="true">
4036 <fileset dir="." defaultexcludes="false">
4037 <patternset refid="greenstone3.source.component"/>
4038 </fileset>
4039 </delete>
4040
4041 <else>
4042 <delete includeEmptyDirs="true">
4043 <fileset dir="." defaultexcludes="false">
4044 <patternset refid="greenstone3.source.no.gli.component"/>
4045 </fileset>
4046 </delete>
4047 </else>
4048 </if>
4049 </target>
4050
4051 <target name="dist-tidy"
4052 description="'tidies-up' a greenstone3 installation for distribution."
4053 unless="${properties.keep.src}">
4054
4055 <!-- delete unneeded things -->
4056 <delete dir="${packages.home}/axis"/>
4057 <delete><fileset dir="${packages.home}" includes="*.zip"/></delete>
4058 <delete file="README-SVN.txt"/>
4059 <delete file="build.properties.svn"/>
4060
4061 <!-- delete source files -->
4062 <antcall target="remove-source"/>
4063
4064 <!-- create empty directories -->
4065 <mkdir dir="${web.writablehome}/applet"/>
4066 <mkdir dir="${web.writablehome}/logs"/>
4067 <mkdir dir="${web.writablehome}/logs/tmp"/>
4068
4069 <!-- Lines with ***** are commented out because these files are useful if we want hybrid installations -->
4070
4071 <!-- os specific tidy-ups -->
4072 <!-- linux, mac -->
4073 <if><bool><istrue value="${current.os.isunix}"/></bool>
4074 <!--*****<delete><fileset dir="." includes="*.bat"/></delete>-->
4075 <if><bool><isset property="with.gli.and.gems"/></bool>
4076 <!--*****<delete><fileset dir="gli" includes="*.bat"/></delete>-->
4077 </if>
4078 <!--*****<delete><fileset dir="gs2build" includes="*.bat"/></delete>-->
4079 <!--*****<delete><fileset dir="bin/script" includes="*.bat"/></delete>-->
4080 <delete file="${basedir}/gs2build/win32cfg.h"/>
4081 <delete file="${basedir}/gs2build/win32.mak"/>
4082 <delete dir="${basedir}/winutil"/>
4083 <delete failonerror="false"><fileset dir="${lib.jni}" includes="*.dll"/></delete>
4084
4085 <!-- windows -->
4086 <else><if><bool><istrue value="${current.os.iswindows}"/></bool>
4087 <!--*****<delete><fileset dir="." includes="*.sh,*.bash,*.csh"/></delete>-->
4088 <if><bool><isset property="with.gli.and.gems"/></bool>
4089 <!--*****<delete><fileset dir="gli" includes="*.sh,*.bash,*.csh"/></delete>-->
4090 </if>
4091 <!--*****<delete><fileset dir="gs2build" includes="*.sh,*.bash,*.csh"/></delete>-->
4092 <!--*****<delete><fileset dir="bin/script" includes="*.sh,*.bash,*.csh"/></delete>-->
4093 </if></else></if>
4094
4095 </target>
4096
4097 <!-- fix up executable permissions for binary release -->
4098 <target name="fix-execute-permissions">
4099 <echo>Setting binaries to executable</echo>
4100 <chmod perm="775">
4101 <fileset dir="."><patternset refid="greenstone3.executables"/></fileset>
4102 </chmod>
4103 </target>
4104
4105 <!-- fix up executable permissions for source code release -->
4106 <target name="fix-execute-permissions-source">
4107 <chmod perm="775">
4108 <fileset dir="."><patternset refid="greenstone3.source.executables"/></fileset>
4109 </chmod>
4110 </target>
4111
4112 <!-- for macs, set up the .app shortcuts to gsi, gli, client-gli and gems -->
4113 <target name="gen-mac-shortcuts">
4114 <if><bool><istrue value="${current.os.ismac}"/></bool>
4115 <filter token="gsdl3srchome" value="${basedir}"/>
4116 <copy file="${basedir}/gs3-server.app/Contents/document.wflow.in" tofile="${basedir}/gs3-server.app/Contents/document.wflow" filtering="true" overwrite="true"/>
4117 <copy file="${basedir}/gli.app/Contents/document.wflow.in" tofile="${basedir}/gli.app/Contents/document.wflow" filtering="true" overwrite="true"/>
4118 <copy file="${basedir}/client-gli.app/Contents/document.wflow.in" tofile="${basedir}/client-gli.app/Contents/document.wflow" filtering="true" overwrite="true"/>
4119 <copy file="${basedir}/gems.app/Contents/document.wflow.in" tofile="${basedir}/gems.app/Contents/document.wflow" filtering="true" overwrite="true"/>
4120 </if>
4121 </target>
4122
4123 <!-- ============= tweaks for making compilation static ========== -->
4124 <target name="tweak-makefiles" depends="init" if="compile.static">
4125 <antcall target="rtftohtml-add-static" />
4126 </target>
4127
4128 <target name="rtftohtml-add-static" depends="init" if="collection.building.enabled">
4129 <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" />
4130 </target>
4131
4132 <target name="run-collection-tests">
4133 <if><bool><not><available file="${basedir}/ext/testing" type="dir"/></not></bool>
4134 <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>
4135 </if>
4136 <for param="testjar">
4137 <path>
4138 <fileset dir="${basedir}" includes="web/sites/*/collect/*/tests/tests.jar"/>
4139 </path>
4140 <sequential>
4141 <echo>Testing @{testjar}</echo>
4142 <java classname="org.junit.runner.JUnitCore" fork="true">
4143 <!--https://stackoverflow.com/questions/38676719/selenium-using-java-the-path-to-the-driver-executable-must-be-set-by-the-webdr-->
4144 <sysproperty key="webdriver.gecko.driver" path="${basedir}/ext/testing/geckodriver"/>
4145 <arg value="gstests.TestClass"/>
4146 <jvmarg value="-DSERVERURL=${default.server.protocol}://${tomcat.server}:${default.tomcat.port}${app.path}${server.default.servlet} "/>
4147 <classpath>
4148 <fileset dir="${basedir}/ext/testing/lib/java">
4149 <include name="*.jar"/>
4150 </fileset>
4151 <files includes="@{testjar}"/>
4152 </classpath>
4153 </java>
4154 </sequential>
4155 </for>
4156 </target>
4157
4158 <target name="build-collection-tests">
4159 <if><bool><not><available file="${basedir}/ext/testing" type="dir"/></not></bool>
4160 <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>
4161 </if>
4162 <for param="compiledir">
4163 <path>
4164 <dirset dir="${basedir}" includes="web/sites/*/collect/*/tests/src"/>
4165 </path>
4166 <sequential>
4167 <echo>Compiling @{compiledir}</echo>
4168 <if><bool><not><available file="@{compiledir}/../build" type="dir"/></not></bool>
4169 <mkdir dir="@{compiledir}/../build"/>
4170 </if>
4171 <javac
4172 srcdir="@{compiledir}"
4173 destdir="@{compiledir}/../build"
4174 includeantruntime="${compile.includeantruntime}"
4175 debug="${compile.debug}"
4176 deprecation="${compile.deprecation}"
4177 optimize="${compile.optimize}"
4178 encoding="${compile.encoding}">
4179 <classpath>
4180 <fileset dir="${basedir}/ext/testing/lib/java">
4181 <include name="*.jar"/>
4182 </fileset>
4183 </classpath>
4184 <include name="gstests/*.java"/>
4185 </javac>
4186 <jar destfile="@{compiledir}/../tests.jar">
4187 <fileset dir="@{compiledir}/../build">
4188 <include name="gstests/**"/>
4189 </fileset>
4190 <manifest>
4191 <attribute name="Built-By" value="${user.name}" />
4192 </manifest>
4193 </jar>
4194 </sequential>
4195 </for>
4196 </target>
4197</project>
Note: See TracBrowser for help on using the repository browser.